Snorkell for Web

Brief overview

Snorkell.ai is a web-based tool that uses AI to produce documentation and inline docstrings automatically for a variety of programming ecosystems. It’s built to generate readable, developer-friendly documentation for entire codebases and keeps those docs aligned with changes in the repository by running updates when pull requests are merged.

Languages handled

• TypeScript — generates descriptive docstrings and documentation pages.
• JavaScript — supports modern JS patterns and module systems.
• Kotlin — tailored output for Kotlin idioms and JVM projects.
• Java — produces Javadoc-style summaries and method descriptions.
• Python — creates clear docstrings compatible with common doc formats.

Repository integrations

• Bitbucket — integrates to update docs after merges.
• GitLab — hooks into CI to trigger doc generation.
• GitHub — creates documentation updates tied to PR merges.

How it operates

Snorkell.ai analyzes the most recent committed files and creates documentation based on that code snapshot. Documentation generation is triggered automatically on pull request merges so the produced docs stay in step with the codebase. The system creates a separate change set (pull request) containing the new or updated docstrings so maintainers can inspect and revise the suggestions before accepting them.

Security and review process

• No persistent code storage — docstrings are produced dynamically from the current commit without retaining source files long-term.
• Human oversight — contributors can review, edit, and request changes to the auto-generated documentation via the proposed pull request.
• Audit-friendly workflow — all suggested doc edits are visible in version control history for traceability.

Plans, deployment options, and features

• Access to advanced AI models and higher-capacity processing for larger repositories.
• On-premises deployments for organizations requiring local hosting and tighter control.
• Tiered repository support and feature sets across subscription levels.
• Free tier available alongside paid subscriptions with expanded capabilities.

Alternative option

DraftAid — paid service recommended as a comparable solution for automated documentation generation.