Docs Tooling

Docs Tooling is the OAT lane for setting up, maintaining, and restructuring a documentation surface with OAT.

Use this section when you are adopting the docs app workflow in a repo, maintaining generated navigation, or using the analyze/apply docs workflows. OAT supports both Fumadocs and MkDocs: the site framework changes the surrounding app setup and generated artifacts, but the underlying documentation contract stays centered on index.md and ## Contents.

Contents

• Add Docs to a New Repo - Bootstrap a docs app and adopt the docs workflow in a repo.
• Docs App Commands - Docs CLI surface for init, migration, index generation, and nav sync.
• Docs Workflows - How the docs CLI helpers pair with analyze/apply workflows.

What This Section Is

This section explains how OAT supports docs surfaces, how the index contract works in practice, and which commands or workflows to use for bootstrapping, maintenance, and restructure work.

Who It's For

• Repos adding a docs app for the first time
• Teams maintaining directory indexes and generated navigation
• Users who want a controlled analyze/apply flow for docs changes

Start Here

• Use Add Docs to a Repo when you are bootstrapping a docs surface.
• Go to Commands when you already have a docs app and need the CLI surface.
• Use Workflows when you want analysis-backed restructuring rather than ad hoc manual edits.

Common Tasks

• Bootstrap docs app support with Add Docs to a Repo.
• Maintain docs structure with Commands.
• Use the governed workflow in Workflows.
• Check the underlying docs contract in Docs Index Contract.

Go Deeper

• Add Docs to a Repo - Bootstrap a docs app and adopt the docs workflow in a repo.
• Commands - Docs CLI surface for init, migration, index generation, and nav sync.
• Workflows - How the docs CLI helpers pair with analyze/apply workflows.
• Docs Index Contract - Framework-neutral index.md rules plus Fumadocs and MkDocs generation notes.