You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Make Base's documentation maintenance metadata consistent and make the documentation index complete.
Background
Only a handful of docs currently carry Status: and Last reviewed: headers. The eight undated Core Documents are authoritative but provide no local freshness signal, while docs/output-formats.md exists and is linked from the command reference without appearing in the Core Documents index.
The review identified this as a small governance gap that compounds as the documentation set grows.
Scope
Apply the established maintenance-header convention to the eight undated Core Documents:
docs/why-base.md
docs/architecture.md
docs/technical-overview.md
docs/command-reference.md
docs/execution-model.md
docs/runtime-environment.md
docs/tool-boundaries.md
docs/stability-tiers.md
Use accurate status wording for each document and a common current review date.
Add docs/output-formats.md to the Core Documents index in docs/README.md.
Do not add new documentation pages or redesign the documentation taxonomy.
Do not make historical or internal implementation docs conform unless they are in the listed Core Documents.
Project Fields
Status: Backlog
Priority: P2
Area: Docs
Initiative: Contract Hardening
Size: S
Agent Assignment
Agent-ready after #1757 and #1759 are merged or their content is settled. Use the existing headers in the product and boundary docs as the convention baseline. This is the third implementation PR in the documentation review train.
Source
Derived from the Documentation Review: Base attachment, findings "Inconsistent maintenance-header convention" and "Orphaned doc".
Goal
Make Base's documentation maintenance metadata consistent and make the documentation index complete.
Background
Only a handful of docs currently carry
Status:andLast reviewed:headers. The eight undated Core Documents are authoritative but provide no local freshness signal, whiledocs/output-formats.mdexists and is linked from the command reference without appearing in the Core Documents index.The review identified this as a small governance gap that compounds as the documentation set grows.
Scope
docs/why-base.mddocs/architecture.mddocs/technical-overview.mddocs/command-reference.mddocs/execution-model.mddocs/runtime-environment.mddocs/tool-boundaries.mddocs/stability-tiers.mddocs/output-formats.mdto the Core Documents index indocs/README.md.Acceptance Criteria
Status:andLast reviewed:header.output-formats.mdappears in the Core Documents index exactly once.git diff --checkpasses.Validation
git diff --checkNon-Goals
Project Fields
Agent Assignment
Agent-ready after #1757 and #1759 are merged or their content is settled. Use the existing headers in the product and boundary docs as the convention baseline. This is the third implementation PR in the documentation review train.
Source
Derived from the Documentation Review: Base attachment, findings "Inconsistent maintenance-header convention" and "Orphaned doc".