FAQ from Swimm
What is Swimm?
Swimm is an AI-driven tool for generating code documentation that works within your IDE. It crafts interactive documents based on the context of your code, making documentation tasks simpler and more effective.
How to use Swimm?
Install the Swimm plugin in your preferred IDE. Swimm AI will then analyze your code and propose documentation structures. Use the /generate command to effortlessly add explanations to your documentation. Swimm AI also supports setting document visibility rules and creating documentation from PRs.
How does Swimm AI work?
Swimm AI examines your code and generates document structures based on the code's context. It also provides automatic code explanations, sets up visibility rules, and can create documentation from PRs.
Is my data secure with Swimm?
Absolutely. Swimm secures your documentation and code with encryption, following stringent security and privacy policies. Data sent to OpenAI for AI processing is not used to train or improve OpenAI's models.
What IDE integrations does Swimm offer?
Swimm supports popular IDEs like VS Code and JetBrains through its plugins.
How can Swimm benefit my team's documentation workflow?
Swimm enhances your team's ability to create detailed code documentation, improves collaboration, reduces repeated errors, and seamlessly integrates with your existing development processes.