Skip to content

🧩 Sync Docs in a Monorepo

Use this guide when your source code and documentation live in the same repository.

✅ Before You Start

  • Install the DeepDocs GitHub App on the monorepo (sidebar → Install App on GitHub Repos).
  • Pick the branch you want to keep in sync (typically main or master).

🧭 Step-by-Step (UI Walkthrough)

  1. In the sidebar, select your monorepo.
  2. Open Repository Settings.
  3. Choose a Branch from the branch selector.
  4. In Source Code Context, select the folders/files that represent your product code (e.g. apps/, packages/, services/).
  5. In Target Docs, select the docs you want DeepDocs to keep updated (e.g. docs/, README.md, guides/).
  6. Click Start Scan.

✅ What Happens Next

  • DeepDocs creates a deepdocs-update/ branch and opens a PR if docs are outdated.
  • Future commits on the same branch automatically trigger scans.
  • You can pause or resume scans later using the Pause / Continue buttons in Repository Settings.