Rails conventions make features fast to build and easy to leave undocumented. docs-keeper parses your Ruby with Tree-sitter and drafts the docs that convention-over-configuration tends to skip.
Docs that follow your models, controllers, and routes
docs-keeper reads your Rails app and keeps the README, API docs, and guides current as the app evolves.
What docs-keeper keeps in sync
Model & schema docs
Associations, validations, and attributes documented from the models.
API endpoints
Controllers and routes turned into accurate endpoint reference.
Rake & generators
Custom rake tasks and generators documented as they change.
Upgrade notes
Behavior changes flagged in drafted changelog and upgrade guides.
Docs it writes for Ruby on Rails
README.mdAPI referenceModel referenceCHANGELOG.mdUpgrade guide
Frequently asked
Does it understand Rails conventions?
docs-keeper parses Ruby and reads the merged-PR context, so models, controllers, and routes are documented from the real code.
Will it edit my app code?
Never. It only opens documentation pull requests for your review.
Engines and monoliths?
Include/exclude paths let you scope docs to specific engines or the main app as you prefer.
Try docs-keeper on your Ruby on Rails repo
One public repo, 20 doc PRs per month, no credit card. See if drafts read like your team before committing to a paid plan.