Some context on what happens when you install DeepDocs:
When you install DeepDocs on a specific repo for the first time, it performs a deep scan of your repository and shares a report on whether your README is up to date. If it's not, DeepDocs creates a separate branch with the proposed updates.
If you want DeepDocs to work with a specific file or folder (e.g. `docs/`), you can add a `deepdocs.yml` file at the root of your repo. With this YAML file, you can:
- Set up a continuous documentation pipeline on any branch (e.g. `main`, `feature-branch`). Any commits to this sync branch will trigger a documentation update.
- Run a deep scan of your repo on any branch and fix outdated docs in one go.
When you install DeepDocs on a specific repo for the first time, it performs a deep scan of your repository and shares a report on whether your README is up to date. If it's not, DeepDocs creates a separate branch with the proposed updates.
If you want DeepDocs to work with a specific file or folder (e.g. `docs/`), you can add a `deepdocs.yml` file at the root of your repo. With this YAML file, you can:
- Set up a continuous documentation pipeline on any branch (e.g. `main`, `feature-branch`). Any commits to this sync branch will trigger a documentation update. - Run a deep scan of your repo on any branch and fix outdated docs in one go.
More details in the Quickstart: https://docs.deepdocs.dev/get-started/quickstart/