Skip to content

🔗 Sync Docs in a Separate Docs Repo

If your docs live in a dedicated repository outside your source code repository, then follow the steps below to connect the two repos.

✅ Before You Start

  • Install the DeepDocs GitHub App on both the code repo and the docs repo.
  • Decide which branch in the docs repo should receive updates (for example main).

🧭 Step-by-Step (UI Walkthrough)

1) Mark the docs repo as docs-only

  1. In the sidebar, select the docs repository.
  2. In Repository Settings. pick the correct Branch.
  3. Enable This is a separate docs repository.

This tells DeepDocs the selected repo branch is docs-only, and its doc files can be referred from another source code repository.

When you mark a repo as docs-only, you will also see the docs badge besides the repo name in the sidebar.

2) Connect the docs repo to your code repo

  1. In the sidebar, select the code repository you want to scan.
  2. In Repository Settings and choose the branch to scan.
  3. In Source Code Context, select the code files or folders that affect docs.
  4. In Target Docs, open the picker and expand External Doc Repositories.
  5. Choose the docs repo and branch (shown as repo-name (branch)), then select the docs folders/files to update.
  6. Click Start Scan.

✅ What Happens Next

  • DeepDocs opens a PR in the docs repo on a deepdocs-update/ branch if outdated docs are detected.
  • New commits to the code repo branch automatically trigger updates to the docs repo.
  • Scan logs on the docs repo show updates that were triggered from other repositories.

💡 Tip

  • You can sync both monorepo and separate repo docs from the same source code repo. If outdated docs are detected, two PRs, one in each repo will be opened to fix the docs