Documentation Standard

All documentation in dashecorp repos must follow this format. This applies to every agent (Dev-E, Review-E, iBuild-E) and every human contributor.

Format

• Markdown with YAML frontmatter
• Concise — tables over paragraphs, code blocks for commands
• No fluff, no emojis unless explicitly requested

Required Frontmatter

Every .md file in docs/ must start with:

---
title: "Short title"
description: "One-line description — used for search and indexing"
type: "infrastructure | architecture | standard | guide | reference"
queries: ["what users might search for", "natural language questions"]
updated: "YYYY-MM-DD"
---

Field	Required	Description
title	Yes	Short, descriptive title
description	Yes	One line — what this doc covers
type	Yes	Category: infrastructure, architecture, standard, guide, reference
queries	Yes	List of search queries this doc answers
updated	Yes	Last update date (ISO 8601)

When to Update Docs

A PR must include doc updates if it:

• Adds or changes user-facing behavior
• Modifies infrastructure, deployment, or configuration
• Adds a new component, service, or integration
• Changes environment variables, secrets, or access patterns
• Fixes a bug that was documented incorrectly

A PR does not need doc updates for:

• Internal refactoring with no behavior change
• Dependency bumps (Dependabot)
• Test-only changes
• Code style fixes

Where Docs Live

Scope	Location
Rig infrastructure	dashecorp/rig-gitops/docs/
Agent runtime	dashecorp/rig-agent-runtime/docs/
Conductor-E API	dashecorp/conductor-e/docs/
App repos	{repo}/docs/
READMEs	Root of each repo

Doc Template

Use this as a starting point:

---
title: ""
description: ""
type: ""
queries: []
updated: ""
---

# Title

One-paragraph summary.

## Section

Content with tables and code blocks.

Review Checklist (for Review-E)

When reviewing a PR, check:

1. If the PR changes behavior — are docs updated?
2. Do all .md files in docs/ have valid YAML frontmatter?
3. Is the updated date set to today?
4. Are tables, commands, and references accurate?
5. No broken links to renamed/moved resources?