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 scan.

1️⃣ Install DeepDocs

Install the DeepDocs app on:

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

ℹ️ To install DeepDocs on more repos later, go to your GitHub Installation Settings, click Configure next to DeepDocsAI, select the repos, and hit Save.

2️⃣ Configure DeepDocs

Place a deepdocs.yml file at the root of your repo, in the branch where you're working on e.g. main or a feature branch

Example:

target:
  - url: "docs/"
  - url: "examples/"

include:  ["src"]

reinit: "a-random-string"

What the config means:

  • target.url: A Relative path to a docs files or folder, or a GitHub URL if pointing to an external repo.

  • include: A list of specific source code files or folders to monitor e.g. "src". If left empty, DeepDocs will monitor the entire repo for code changes.

  • reinit: A random string used to reinitialize DeepDocs

ℹ️ Changing the reinit string reinitializes DeepDocs, and is useful in situations when the difference between two commits is significantly large.

3️⃣ Trigger the First Scan

As soon as you commit deepdocs.yml:

  • DeepDocs initializes and runs a deep scan to detect outdated docs.
  • Gives you a report (as an email) on which docs are outdated and why
  • Creates a branch: deepdocs-update-<branch>-<commit_sha> with proposed updates. Here, <branch> is your current branch name and <commit_sha> is the commit of deepdocs.yml

Every subsequent commit will trigger an automatic scan and fix of outdated docs as described above.

ℹ️ DeepDocs is designed to keep existing docs updated. To create docs from scratch use @DeepDocs: in an empty markdown file. DeepDocs will write your doc as per your instructions.

Code and Docs Stay Together, Forever 🚀