Skip to content

🚀 Quickstart Guide

DeepDocs scans your docs for staleness on every commit, and this guide shows you how to set up automated scans for your repositories.

👤 For Personal Repositories

  1. Sign in to DeepDocs
  2. Install the GitHub App — choose All Repositories or specific ones.
  3. After installation, your repositories appear in the sidebar.
  4. Click any repository to open it.

  5. In Repository Settings:

    • Select a Branch (e.g., main or master)
    • Add Source Code Context (files or folders to monitor for code changes)
    • Add Target Docs (files or folders like README.md or /docs to keep updated). If your docs are in a separate repository, refer this guide

  6. Click Start Scan ▶️

  7. If outdated docs are detected, DeepDocs updates them in a new branch deepdocs-update/ (e.g.deepdocs-update/main) and opens a PR,
  8. (Optional) Once the scan is complete, view the dashboard log:
    • See how many docs were outdated
    • View a detailed report explaining which files were updated and why
    • Access a direct link to the commit on the updated branch

🏢 For Organizational Repositories

  1. Click the Workspace Switcher (top-left).
  2. Click Can’t find your org? Grant permission.
    • Only Admins/Owners of a GitHub organization can perform this action.
  3. Authorize DeepDocs for your organization.
  4. Once added, select the organization workspace from the switcher.
  5. Install the GitHub App on the desired repositories.
  6. On your chosen repository: select branch → source code → target docs → start scan → review PR (steps 4-7 as above)
  7. (Optional) After the scan, view the dashboard log for details on the scan.
  8. (Optional) Add your team members to the repository by clicking Manage Members

🔁 After Setup

  • Each commit automatically triggers a documentation scan.
  • Outdated docs are updated in a deepdocs-update/ branch, and a PR is opened.
  • The dashboard keeps a log of all scans and their results.

💡 Tips

  • Keep Source Code Context narrow & relevant to reduce scan time and credit usage
  • Pick a stable branch (e.g., main or staging) so scans run only after final changes merge, reducing unnecessary scans and credit use.
  • Use folder paths for Source Code Context and Target Docs to automatically detect and sync newly added files.
  • Use the scan logs in the DeepDocs app to audit what was updated and why.
  • If your docs live in a separate repository, refer this guide.