Documentation taxonomy
Overview
Use kind in a page's YAML frontmatter to identify its document type and
select its template. A kind describes the content. The site menu and file
location follow the reader's task and the repository layout.
| Kind | Applies to | Template | Example |
|---|---|---|---|
reference/ci |
One test workflow's triggers, scenarios, execution, and result limits | CI check | CI required checks |
reference/driver |
The shared interface and lifecycle for one Driver capability | Driver contract | SandboxDriver contract |
reference/driver/impl |
One Driver implementation's provisioning, configuration, and operating limits | Driver implementation | OpenShell or Kubernetes implementation reference |
Copy the selected template, including its frontmatter, when you write a new page.
Use reference/driver for the shared capability contract and
reference/driver/impl for a specific implementation. Add new kinds and template
links here and in the technical-writing skill's mapping table in the same change.
Use reference/ci for the test workflow detail pages linked from the
CI overview. Shared setup guides and the overview do not use
this template. Keep the six sections in order: Overview, Trigger, Scenarios,
Execution, Results and limits, and Files.