.png)
3 months ago
2
Frequently Asked Questions
DeepDocs is a GitHub-native AI agent that keeps your API docs, SDK guides, tutorials etc. in sync with your codebase automatically. It listens for code changes, detects outdated docs, and makes updates in separate branches with detailed reports.
Does DeepDocs create documentation from scratch?DeepDocs is designed to maintain existing documentation, not generate it from scratch. If you’re starting from zero, AI code tools like GitHub Copilot, Cursor etc. can help draft the initial version. Once your docs are in place, DeepDocs keeps them in sync with your codebase—automatically updating them with every commit.
How can I set-up DeepDocs on my repository?DeepDocs can be set-up in 3 easy steps
1. Install the app from GitHub marketplace
2. Specify which target docs files or folder you want to track in deepdocs.yml file
3. Commit the file at the root of your repo
Commit the file at the root of the repo to trigger a deep scan of your repo and update any broken docs. Future commits will automatically trigger doc updates. For more details, refer the Quickstart guide
No. DeepDocs intelligently updates only the relevant portions of your documentation. It preserves your existing format and avoids rewriting files from scratch.
What is the difference between Deep Scan and Continuous Documentation?Deep Scan is a DeepDocs feature that performs a repo-wide analysis to detect and fix outdated documentation in one go. You can trigger it manually at any time to get an immediate overview of missing or stale docs.. For more details, refer this guide on Deep Scan.
Continuous Documentation is the core feature of DeepDocs. It gets triggered on every commit, identifying and updating only the affected documentation. For more details, refer this guide on Continuous Documentation.
DeepDocs uses 1 credit for Deep Scan and 1 credit for Doc Update process
Can’t AI Coding Agents like Cursor or Copilot also create documentation?They can, but only when you manually prompt them what to update. DeepDocs works differently. It brings continuous documentation to your workflow, just like CI/CD replaced manual deploys, DeepDocs replaces manual doc updates. It also works with a full code-to-doc context, so it knows what changed and which docs are affected, without needing prompts.
