Subscribe
Sign in
Swimm AI (Beta) — The smartest way to document code
Introducing Swimm AI ✨. Generate code documentation from scratch and make sure that dev knowledge surfaces when needed most. Join our open beta (it’s free!) and experience the future of documentation.
71
Replies
Best
@sentry_co Great! Using Swimm, you'll be able to create docs that describe flows that go through multiple files and repos, so far more elaborate than comments in the code.
We have plugins for VS Code and Jetbrains IDEs. We don't support X Code yet.
@sentry_co Yes. But also docs on how to do certain things, best practices, explanations about data flows, business logic and much more. Basically, any context about the code that a developer would need to work with it or contribute to it.
@sentry_co thanks for asking about this! This is the relevant part of OpenAIs terms, which can be found in the link at the bottom:
1. OpenAI will not use data submitted by customers via our API to train or improve our models, unless you explicitly decide to share your data with us for this purpose. You can opt-in to share data.
2. Any data sent through the API will be retained for abuse and misuse monitoring purposes for a maximum of 30 days, after which it will be deleted (unless otherwise required by law).
Please read more here: https://openai.com/policies/api-...
Needless to say, we did not opt-in to share data.
Amazing work guys! I love how Swimm helps eliminate the need for writing in-depth explanations of developer knowledge and that I can generate explanations of code snippets, effortlessly.
Congrats on the launch ! The tool looks promising, we are doing something similar at my company but for Devops to automate infra documentation. May I ask what software you used for generating the launch video? looks great :)
@alexandre_guerin Figma for storyboarding and AfterEffects for animation. But most importantly - our Marketing team (:
@oren_toledano1 @omerr huge congrats on the launch of Swimm AI - this feels like something incredibly special in modernising developer workflows. Chapeau to you and the team.
With Swimm.ai, we're not just changing the way you document your code; we're making it an enjoyable experience! Imagine that – creating detailed documentation as quickly as you can code, and all thanks to AI!
Love what the Swimm team are doing, and with AI superpowers this will be a game changer 🚀
@michael_hollander @tom_ad Michael! Thank you, this set of new features is bringing us to the next level.
I have faced such the task so many times while working at tech products. So I found this product quite helpful and allowing cut the manual repetitive tasks. Awesome 👏
@xeniagoron Indeed, that's really what we had in mind while building this, how can we make it so easy it would be a no brainer (and even enjoyable) to make it part of your day2day.
@xeniagoron happy to hear! Even happier to hear that Swimm will save you time.
Hey Swimm team, kudos on launching Swimm AI Beta🎉
As a frequent user of code documentation tools, I'm thrilled to see how Swimm AI enhances the documentation process by leveraging AI capabilities. The concept of Auto-sync to ensure up-to-date documentation is ingenious and I'm looking forward to seeing it in action.
I'd like to provide a couple of recommendations for consideration:
The feature to generate documentation from PRs is impressive. It could be taken a step further if there was a way to directly link the generated documentation back to the PR, allowing easy access and understanding of the changes made and why they were made.
Additionally, consider integrating with popular code hosting platforms like Bitbucket or GitLab to extend your user base and facilitate seamless documentation for users on these platforms.
I'm also launching soon with ezML, a no-code platform for AI (computer vision) development, so feel free to follow us at https://www.producthunt.com/prod....
Once again, congratulations on the launch! I'm looking forward to seeing where Swimm AI heads, and I believe it has a great potential in improving the coding landscape.
@sean_dorje I'm glad to see you are enthusiastic about Swimm AI. Your recommendations are very insightful 💡. We definitely see the value in linking generated documentation directly to PRs. It would certainly enhance the traceability of changes and the understanding behind them.
About expanding our integrations with more popular hosting platforms such as Bitbucket and GitLab - that is already in motion 👌 and few weeks a head will be available. Congrats on launching ezML. It sounds fantastic, and we will definitely keep an eye on your progress.. I'm curios about the use cases it provides.
Thanks, and good luck.
Nadav, Senior PM Swimm.io
Congratulations on the introduction of Swimm AI, a remarkable tool that generates code documentation from scratch! The ability to ensure that developer knowledge surfaces precisely when it is needed the most is truly invaluable. As a software developer, I understand the significance of comprehensive and easily accessible documentation in enhancing productivity and collaboration.
To gain a deeper understanding of Swimm AI, I'm curious about the underlying mechanisms that enable the generation of code documentation. How does Swimm AI analyze codebases and extract relevant information to create accurate and up-to-date documentation? Does it employ specific parsing techniques, natural language processing (NLP), or other AI algorithms to extract meaningful insights from the code?
Additionally, the emphasis on surfacing developer knowledge at the right moment is intriguing. Could you elaborate on how Swimm AI achieves this? Are there specific integrations or features that allow developers to access the relevant documentation seamlessly during their coding workflow? How does Swimm AI ensure that the generated documentation stays synchronized with the codebase as it evolves over time?
Moreover, the opportunity to join the open beta and experience the future of documentation is enticing. Could you provide more details about the key features and benefits that users can expect from Swimm AI? Are there any plans to introduce additional functionalities or integrations in the future?
Overall, Swimm AI appears to be a promising solution for code documentation, empowering developers with instant access to knowledge. Congratulations once again on this impressive achievement. I'm eager to learn more about the technical aspects of Swimm AI and how it revolutionizes the way we document and share knowledge within the development community.
Hey @gordon_n , thanks for reaching out!
We can't reveal everything about how Swimm AI works under the hood 😇 I will relate to what I can though:
> Does it employ specific parsing techniques, natural language processing (NLP), or other AI algorithms to extract meaningful insights from the code?
We use LLMs (with honed promps), as well as our own static analysis
> Could you elaborate on how Swimm AI achieves this? Are there specific integrations or features that allow developers to access the relevant documentation seamlessly during their coding workflow?
Swimm's Regex-based Rules is a feature that links your codebase to relevant documentation using regex rules. Without AI, you can create those regex-based rules yourself. With Swimm AI, you can (a) Discover use cases: Swimm AI will generate the top 3 use cases relevant to your document, and (b) turn those use cases into regexes.
You can learn more about it here:
https://docs.swimm.io/Swimm-AI/R...
> How does Swimm AI ensure that the generated documentation stays synchronized with the codebase as it evolves over time?
That's our auto-sync functionality, as explained here :)
https://docs.swimm.io/Features/k...
> Could you provide more details about the key features and benefits that users can expect from Swimm AI? Are there any plans to introduce additional functionalities or integrations in the future?
We have lots of plans, but we will reveal them gradually 😇 Feel free to be in touch in the upcoming weeks
Thanks again for your interest and questions
Wow! The latest update to the product is absolutely incredible and brings a whole new level of capabilities!
The future of documentation sounds like a reasonably ambitious goal! Congrats on the launch :)
Swimm