Documentation automation
Tune documentation automation with push triggers, writing skills, output folders, and a project style guide.
Use a document project's Automation settings to manage connected repositories, how docs are updated, and writing defaults. Project settings are split into Project, Sources, Automation, and Writing sections.
Repositories and push triggers
In the Sources section, connect the repositories and branches used as evidence for your docs. Turn on Trigger on push for a source to have Specify prepare proposed document updates whenever you push code to that branch.
If you turn on the push trigger only for the default branch (for example, main), changes on work-in-progress branches won't mix into your proposed updates.
Writing skill
The Writing skill is the writing discipline the agent follows when it generates docs. Choose a skill that fits the document type, and add auxiliary skills if needed. You can select up to 5 auxiliary skills.
Default output folder
Choose the folder where generated docs are saved. If you don't choose one, they're saved in the current project folder.
Project style guide
Write the Markdown rules to apply to this project's docs. Because it's more specific than the workspace style guide, the project style guide wins when they conflict. If you leave it empty, only the workspace guide applies.
## Tone
- Prefer prose over tables
- Name the owning team in each section
## Terminology
- Write "customer" instead of "user"
- Format API names as code (`like_this`)Apply policy
Whether proposed updates are applied automatically follows your project settings and the policy applied to your workspace. New projects start without automatic updates, and when automatic updates are allowed, low-risk changes may be approved automatically. For the review flow, see Review and apply proposed updates.