DocForge Logo

Monitor and maintain your docs

Link your docs and code to keep everything up-to-date.

Declare code dependencies right in your Markdown files

DocForge searches your GitHub repositories for files that contain dependency annotations. No complex setup or build process, just install the GitHub app and DocForge will parse your files each time you push.

# Dependency annotations in DocForge

When writing reference guides or user manuals, a page's content often correspond to parts of the codebase.

DocForge allows you to track these relationships between docs and code with simple annotations. For example:

<!-- depends-on-source: src/feature/code.ts -->

Track all your dependencies in one place

Get a bird's-eye view of how your docs relate to your code. DocForge's web interface provides a centralized location allowing you to quickly jump to docs and their dependencies.

Automatically flag potentially stale docs during code review

When you open a pull request, DocForge will check if any changed code is depended on by your docs. Relevant documents are flagged and added to a convenient queue. A GitHub Check result is created which can block a merge until flagged documents are checked.

Code intelligence for accurate and actionable results

DocForge understands your code and supports dozens of programming languages. Customize the sensitivity of code monitoring so only meaningful changes flag associated documents as stale.

# Customize the sensitivity of dependency monitoring

Don't want small changes and bug fixes to flag your documentation as potentially stale?

Just add some threshold options! For example, if you wanted to flag a document only if a new class or method appears/disappears, you could write the following annotation:

<!-- depends-on-source: src/feature/code.ts
{'thresholds': {'class': 1, 'method': 1}} -->

This works with all your favorite symbol types (function, interface, etc...) across your stack's languages.