docs-builder
Loading

Documentation set

A documentation set is a single folder containing the documentation of a single repository. This is the fundamental unit of documentation in the docs-builder system.

At a minimum, a documentation set folder must contain:

  • docset.yml - The configuration file that defines the structure and metadata of the documentation set.
  • index.md - The entry point or landing page for the documentation set.

Documentation sets allow each repository to maintain its own documentation independently. Each set can be:

  • Built independently.
  • Versioned separately.
  • Maintained by different teams.
  • Published to its own schedule.

A typical documentation set might look like:

 my-repo/ └── docs/ ├── docset.yml ├── index.md ├── getting-started.md ├── configuration/ │ ├── index.md │ └── advanced.md └── reference/ └── api.md

The docset.yml file controls how the documentation set is structured and built. See Content Set Configuration for complete configuration details.