Skip to content

Documentation governance ​

Ownership and lifecycle boundaries for public guidance, current program records, and indexed history; authoring rules live outside the public site.

ClassPathReader and authority
Use Coraldocs/use/**Application users; shipped behavior and limits
Embed Coraldocs/embed/** and package READMEsPublished-package consumers; public APIs, requirements, and examples
Contribute to Coraldocs/contribute/**Repository contributors; setup, maintenance, tests, and release operations
Current program recordsdev/requirements.md, dev/ARCHITECTURE.md, dev/documentation-style.md, designs, and active release recordsProduct authority, decisions, design, plans, style, and current evidence; not published by VitePress
Indexed historydev/archive/**Recoverable provenance; non-authoritative and excluded from current documentation gates

Fact ownership ​

A fact has one owning surface. Other pages link to that owner or stay silent when a link would import a claim they cannot verify. Contributor pages cite commands and paths, while manifests, workflows, scripts, and program records remain canonical for executable facts.

FactCanonical ownerDrift evidence
Toolchain, workspaces, and npm commandsRoot and workspace manifests, lockfile, and toolchain scriptToolchain tests and contributor documentation contract
CI and release behaviorWorkflow and release scriptsWorkflow-policy, release, and contributor checks
User features and figuresUse Coral feature and figure recordsDocumentation structure check
Package APIs and examplesPackage READMEs and Embed Coral examplesLibrary documentation, API, and consumer checks
Authoring rulesdev/documentation-style.mdMarkdown lint, documentation checks, and review values named there
Historical lifecycleArchive index and approved dispositionsContributor contract and current-link resolver

Page lifecycle ​

New public guidance goes under the audience whose reader performs the task. Lookup records belong in reference/; one ordered task belongs in how-to/; each audience has at most one get-started.md. Every public page ends with a Related section so readers can move without search.

The root README routes audiences rather than duplicating their facts. Optional hooks, coding-agent tooling, and local integrations can point to the durable rules but are not contributor prerequisites or documentation authorities.

Current records and history ​

Active release evidence stays under dev/releases/<version>/. After a release is complete and archival is approved, its evidence moves as one recoverable Git unit under dev/archive/releases/<version>/; the archive index and every live pointer change in the same patch. Historical text is not rewritten to current terminology or tool versions.

Behavioral designs remain current under dev/designs/ after implementation. Release-specific closure designs move with their release. Status metadata may be corrected without rewriting the design substance.

Validation ownership ​

npm run check:docs composes the user page/feature/figure check, library README/example/package check, contributor route and hygiene contract, and current-link resolution. VitePress and static builds prove emitted routes. Slice 77 closes final whole-corpus Markdown semantics after the Slice 75 implementation handoff; Slice 80 owns final registry, deployment, platform, performance, and release claims.