Skip to content

🚀 Quickstart Guide

Get started with DeepDocs in just a few steps. This guide will walk you through installing DeepDocs, setting up continuous documentation, and triggering your first update.

1️⃣ Install DeepDocs

Install the DeepDocs GitHub App on:

  • Your repo with source code and docs
  • Any external docs repo if applicable

To add more repos later, go to your GitHub Installation Settings, click Configure next to DeepDocsAI, select the repos, and hit Save.

ℹ️ DeepDocs must be installed on both the source and target repos if they are separate.

2️⃣ Configure DeepDocs

Add a deepdocs.yml file at the root of your repo.

Example:

target:
  - url: "docs/"

reinit: "a-random-string"

ignore: []

What the config means:

  • target.url: A Relative path to a docs file or folder that DeepDocs should sync, or a GitHub URL if pointing to an external repo. Maximum one

  • reinit: A random string used to trigger Deep Scans. Ignore for now.

  • ignore: Optional list of relative paths to exclude from syncing.

Commit it to the branch (sync branch) you want DeepDocs to monitor for code changes (e.g. main or a feature branch).

ℹ️ If your docs are in a separate repo, just install DeepDocs there. You don’t need a config file in that repo.

3️⃣ Trigger the First Deep Scan

After committing deepdocs.yml to your sync branch:

  • DeepDocs runs a one-time Deep Scan to detect outdated docs.
  • It creates a branch: deepdocs-update-<commit_sha> with proposed updates.

What you get:

  • Updated docs
  • A summary report as a comment explaining what changed and why

You can review this branch and merge it back to the sync branch.

ℹ️ To trigger a new Deep Scan later, just change the reinit string.

4️⃣ Automatic Updates on Future Commits!

Once DeepDocs is configured:

  • Every new commit to your sync branch triggers a doc sync process
  • DeepDocs checks the code diffs, identifies affected documentation, and proposes updates

This workflow continues automatically, keeping your docs in sync as your code evolves.

🎁 Bonus: Instant Deep Scan on Install

When you install DeepDocs for the first time, it automatically performs a one-time Deep Scan on the README.md file in the main branch. It is applicable to the first 3 repositories where it's installed.

This gives you an immediate preview of how DeepDocs works—without needing to configure anything up front.

You can review the generated deepdocs-update-<commit_sha> branch and see the detailed report just like in a regular sync.