Open Agent Toolkit

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 Markdown, Fumadocs, and MkDocs. Plain Markdown keeps authored files without a site build; the site framework changes the surrounding app setup and generated artifacts, but the underlying documentation contract stays centered on index.md and ## Contents.

Contents

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 setting up or adopting Markdown documentation or a docs app
  • 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

Go Deeper

  • Add Docs to a Repo - Set up Markdown or a docs app and safely adopt existing Markdown.
  • 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.

On this page