DocFlow connects to your GitHub repo. After configured PR merges, it prepares README, API docs, and changelog drafts — so your documentation can stay in sync with developer review.
GitHub-native. No separate DocFlow password required. Works with public repos for free.
How It Works #
Install the GitHub App
Grant GitHub App access to selected repos. DocFlow reads the repository context needed to generate documentation.
Merge a PR as usual
No CI pipeline changes for the standard setup. DocFlow detects configured merge events and analyzes what changed.
git merge main
Review auto-generated docs
DocFlow posts a PR comment with draft README sections, changelog, and API updates. Approve or edit — your call.
Deep GitHub Integration
Works where your code already lives, reducing dashboard hopping and context switching.
Review-ready updates
Documentation drafts can keep pace with code changes while staying under developer control.
Features #
AI provider disclosure: DocFlow combines deterministic AST parsing with DeepSeek's deepseek-chat model for draft generation. Generated documentation is presented for developer review before use.
PR-Triggered Auto-Documentation
After every PR merge, DocFlow automatically analyzes the diff and generates documentation updates, keeping your docs synced with every ship.
AST + DeepSeek LLM Hybrid Engine
AST analysis extracts exact function signatures, parameters, types, and class structures. DocFlow's current production AI provider is DeepSeek, using deepseek-chat by default for natural-language documentation drafts.
struct
Node {type: AST_TYPE, body: string
}
Incremental Processing
DocFlow is designed to analyze changed files in a PR instead of the entire codebase, reducing unnecessary processing.
PR Comment Preview
DocFlow posts a PR comment showing exactly what it will change. You review and edit before anything lands on main.
Automatic Changelog
Every PR gets a semantic changelog entry generated from commit messages plus deep code analysis.
Multi-Language Support
Python, JavaScript, and TypeScript at launch. Go, Rust, and Java coming next to cover the full developer stack.
Install DocFlow in Seconds #
DocFlow is a GitHub App. Install it on your repository and documentation drafts are prepared from configured PR activity — no required CI pipeline changes or CLI setup for the standard flow.
Click the button below
You'll be taken to the DocFlow GitHub App installation page.
Choose your repository
Select individual repos or grant access to all repositories in your organization. Free plans work with public repos immediately.
Done — review-ready drafts on merge
From the next configured PR merge onward, DocFlow analyzes changes and prepares README, API docs, and changelog drafts for review.
[Install the GitHub App](https://github.com/apps/docflow-niao/installations/new)
Free for public repositories. No credit card required.
Free
- Unlimited public repos + 1 private repo
- Up to 100 doc-generating PRs/month
- Changelog + README updates
Pro
-
10 private repos
-
500 PRs/month
-
README + changelog + API docs + inline comments
-
Custom README templates
-
Email support (48h)
Team
-
50 private repos
-
2,000 PRs/month
-
Everything in Pro plus team dashboard
-
Doc quality scoring
-
Email support (24h)
Enterprise
- Unlimited repos and PRs
- SSO/SAML integration
- Audit logs & Security reports
- Dedicated support engineer
Frequently asked questions #
Python, JavaScript, and TypeScript at launch. Go, Rust, and Java are planned next. DocFlow uses AST analysis to help documentation follow code changes, but generated output still needs review.
DocFlow is not designed to store full repository source code. It may store repository metadata, configuration, generated documentation, and processing history, and it processes the code context needed to generate docs. Relevant context may be sent to DeepSeek, the current production AI provider.
DocFlow's current production configuration uses DeepSeek as the AI provider, with deepseek-chat as the default model. DocFlow first extracts code structure with AST analysis, then sends the limited context needed for a documentation draft to the configured AI endpoint. If the production provider or model changes, this disclosure will be updated.
Yes. DocFlow supports custom README templates, custom changelog formats, and configurable inline comment styles. You define the template once, and DocFlow applies it to every PR.
DocFlow posts its changes as a PR comment first. You review and edit before anything lands on main. You can also configure DocFlow to create a separate branch with its changes, giving you full control.
Free for public repos. Private repos are billed per PR processed. No monthly minimums. If you exceed your plan limits, DocFlow stops processing and notifies you — no surprise charges.
Not yet. DocFlow is currently a managed GitHub App. Self-hosting is on the roadmap for 2025.
You're shipping code every day. Your team is growing. #
But the docs are often behind… DocFlow turns documentation into a review-ready byproduct of shipping code — not a separate task you need to remember from scratch.
No credit card for public repos. Minimal setup. Connect your repo and review generated drafts.