Launched this week
DocFit
Docs PRs opened for you when your code merges
36 followers
Docs PRs opened for you when your code merges
36 followers
DocFit is documentation CI for GitHub. When a code PR merges, it finds the affected documentation, write fixes, verifies it with build, lint and any custom commands, and then opens a docs PR for your team to review. It never merges on its own.
Free Options
Launch Team / Built With
AWS Startup AdvisorPersonalized AWS guidance that meets you where you’re already building
Promoted
Hi Product Hunt
DocFit is a GitHub App for one job: keeping API documentation in sync with the code that just merged.
For past 6 years I have worked a lot on the backend writing and modifying API endpoints on daily basis. As an API first company we used to make sure to update our API documents before releasing the changes. In past 2-3 years, with AI now writing the code, we are merging way more changes than our engineers could maintain docs for.
The problem is familiar to anyone who maintains API docs, public or private. A pull request merges, the code is correct, and a docs page is now wrong. Often it isn't the headline change. In our public example, a PR titled "filter refunds by reason" also lowered the maximum page size from 100 to 50, and the docs page never listed the limit at all. Nobody reviewing the code saw the docs page; nobody owning the docs saw the code PR.
What DocFit does on every merge:
1. Decides whether docs could be affected. If not, it leaves a "No docs impact" comment and stops.
2. Reads the whole change: diff, commits, review comments and the linked Jira or GitHub issue.
3. Finds affected pages or if any new documentations are required.
4. Fixes the documentation in your documentation framework's format.
5. Checks it: your docs build and linters, links, OpenAPI lint, and any custom commands.
6. Opens a docs PR for your team and notifies you over Slack. DocFit never merges.
Works with Mintlify, Docusaurus, Redocly/OpenAPI, MkDocs, Nextra, VitePress and plain Markdown, in the same repo or a separate docs repo.
See real output without signing up:
- the code PR: https://github.com/Docfit/exampl...
- the docs PR DocFit opened: https://github.com/Docfit/exampl...
Free for public repos and one private repo. During setup you can dry-run it on your last 5 merges and see what it would have changed.
We'll be providing extended free trial for Team plan in exchange for honest feedback on the docs PRs. Reply here or email contact@docfit.dev.
I'd love to hear any suggestions or feedback.
@cddharthsingh Congrats on the launch! This is really useful, my team has experienced this countless times and even with full AI code factories its hard to keep docs updated. Would love a function to generate/update docs to different audiences. One technical and one not so technical.
@frederic_rohrer if you maintain different versions of Docs - DocFit already takes care of them. If you haven't set it up then you can define repository rules and mention you want have 2 version and DocFit will follow the rules
Congrats @cddharthsingh on the launch!
Very useful in the vibe coding era!
How does @DocFit handle situations where API documentation is missing? Does it generate the documentation automatically?
Also, how does it handle MCP integrations?
@ilyasb While setting up the repository we ask user if they already have API documentation or if they want to start from scratch. DocFit can write the documentation from scratch in the same or a different repository. After that first write it'll keep them up to date with the latest code changes. MCP integration is in final stages of QA - will be launching it soon.
Docs drifting from the code is the thing nobody owns on a small team. Could it keep AI instruction files like CLAUDE.md and skill files in sync too? Ours go stale just as fast.
@dan16 if your skill files and claude.md are affected by code changes then yes, DocFit can take care of those as well. DocFit reads all the merged code PR and then check them against your API and Docs codebase to find out all affected pages and required new pages. Make smallest possible changes and raise the Docs PR and notifies you over email and slacks so that you can review and merge.
You can leave comments and request changes on the PR and DocFit will learn from them and apply it in subsequent PRs
As more humans and AI are doing more and more coding work on github, this is a quite useful product for managing the docs every time and keeping things clean! Thank you @cddharthsingh for launching this! May I ask how easy it is for the user to handle a merge conflict and do you support multi-language docs?
@xwang146 Thanks Amy.
Incase of merge conflicts you can just add a comment in the PR - "@DocFit - fix conflicts", it'll go through the PR again and fix the conflicts.
Yes, I have worked with multiple formats for documentation - JSON, yaml, md, mdx and many more - DocFit supports all formats.
@julius_hnz Thanks Julius.
When setting up your repository, you get an option to select members from your GitHub organization whom you want to be assigned as reviewer. When a docs PR is raised selected members are requested for PR review.
Also a notification is sent on Slack channel. So as per your company's policy whoever is responsible can take up the PR for review.
But your question gave me an idea - I should give an option to auto assign PR review to a member who raised original code PR. Will implement this soon.
Seems cool, according to my experience it is sometimes hard for some of team members to work with git. Do you have any online modification facility that still store the doc on Git?
@mehrdad_shobeyri That is a very common bottleneck in teams where product managers or non-technical writers need to tweak copy without dealing with Git branches!
Right now, DocFit operates natively inside your Git workflow (opening pull requests automatically when code merges, and letting reviewers make quick edits or use @docfit commands directly in GitHub).
However, because DocFit edits standard Markdown/MDX/JSON/Yaml files directly in your Git repository, any online markdown editor or headless Git-backed CMS (like GitHub's web editor, StackEdit, or GitBook-style web UI connected to your repo) will automatically sync with what DocFit produces.
Are your team members looking for a simpler web UI to review/edit what DocFit generates before merging, or would a built-in web scratchpad in DocFit be something you'd want?"