Documentation URL contract (core and modules)
The authoritative URL and ownership rules for both documentation sites are maintained in the modules repository so bundle paths, redirect_from history, and permalink policy stay in one place.
Canonical reference
- Core and modules docs URL contract (
specfact-cli-modules) — read this before changing cross-site links or permalinks.
Quick rules for core contributors
- Do not assume a modules guide lives at
/guides/<name>/just because core uses/guides/<name>/. Modules uses/guides/.../,/bundles/.../,/integrations/.../, and root paths such as/brownfield-engineer/depending on the page—always verify the target file’spermalinkinspecfact-cli-modules. - Handoff pages (see OpenSpec
docs-07-core-handoff-conversion) must point to the modules canonical URL for each topic, with a short summary and prerequisites on core. - Internal core links must continue to resolve on
docs.specfact.ioper publishedpermalink(docs review gate / parity tests).
First-contact handoff contract
docs.specfact.iois the default starting point for first-time users.modules.specfact.iois the deeper workflow and bundle documentation layer.- Core docs must explain what extra value the modules docs provide before linking users there.
- Modules landing pages must send un-oriented users back to the core docs when they still need the product story, first-run guidance, or overall navigation context.
- Both sites must preserve the same product identity: SpecFact as the validation and alignment layer for software delivery.
Repositories
| Concern | Repository |
|---|---|
| Core CLI docs source | nold-ai/specfact-cli → docs/ |
| Modules docs source | nold-ai/specfact-cli-modules → docs/ |