Skip to main content

​
Docs Guide (Internal Source of Truth)

This section is the canonical landing page for repository features, operating rules, and supporting catalogs. Use it as the repo systems map, not as a replacement for executable code, tests, or generated indexes.

​
Source-of-Truth Model

  • Runtime behavior: source of truth is code and tests.
  • Feature and operations navigation: source of truth is this docs-guide/ section.
  • Public docs UX/content: source of truth is Mintlify pages under v2/.
  • Generated catalogs: source of truth is generator scripts; generated files are read-only outputs.
See source-of-truth-policy.mdx for full boundaries.

​
Section Routes

SectionPurposeCanonical entry points
ContributingHow to work in the repo safely and consistentlycontributing.mdx, mintlify.mdx
FeaturesMajor repo systems, automation surfaces, and functional mapsfeature-map.mdx, architecture-map.mdx, automations.mdx, data-integrations.mdx, ui-system.mdx, visual-explainer-workflows.mdx
ToolingCLI, developer tooling support, and reusable authoring reference mapslpd-cli.mdx, dev-tools.mdx, content-brief-template.md, icon-map.mdx
FrameworksGuides, helpers, structural models, and improvement workflowscontent-system.mdx, component-governance.mdx, research-skill-workflow.mdx
PoliciesEnforced rules, prohibited actions, gate-owned controls, and audit standardssource-of-truth-policy.mdx, generated-artifact-and-hook-governance.mdx, v2-folder-governance.mdx, quality-gates.mdx, audit-system-overview.mdx, skill-pipeline-map.mdx, cleanup-quarantine-policy.mdx, component-layout-decisions.mdx, infrastructure-principles.mdx, ownerless-governance.mdx, root-allowlist-governance.mdx, agent-governance-framework.mdx
CatalogGenerated catalogs plus manual reference indexesai-tools.mdx, ui-templates.mdx, pages-catalog.mdx, components-catalog.mdx, scripts-catalog.mdx, workflows-catalog.mdx, templates-catalog.mdx

​
Frameworks vs Policies

Use Frameworks for guides, helpers, warnings, models, and other improvement-oriented operating guidance. Use Policies for enforced rules, prohibited actions, canonical path contracts, and other constraints owned by hooks, validators, or audit gates. component-framework.mdx is retained only as a compatibility page for the older route; component-governance.mdx is the canonical framework source. Agent governance remains in Policies, not Frameworks, because approved instruction-file locations, overlap boundaries, and retirement targets are part of the repository’s enforced operating contract. The same applies to V2 folder lanes because publishability, reserved paths, and workspace boundaries are path-governance rules enforced across routing, Mint, and audit tooling. Archives remain under docs-guide/archive/ and docs-guide/catalog/, but archived pages are not canonical entry points and should not be surfaced in active navigation.

​
Update Rules

  1. Update manual docs when behavior, process, canonical boundaries, or architecture changes.
  2. Regenerate generated catalogs when scripts, workflows, or templates change:
    • node tools/scripts/generate-docs-guide-indexes.js --write
    • node tools/scripts/generate-docs-guide-pages-index.js --write
    • node tools/scripts/generate-docs-guide-components-index.js --write
    • node tools/scripts/generate-ui-templates.js --write
    • node tests/unit/script-docs.test.js --write --rebuild-indexes
    • node tools/scripts/enforce-generated-file-banners.js --check
  3. Re-run the docs audit pipeline when docs, scripts, reports, or routing paths change:
    • node tools/scripts/repo-audit-orchestrator.js --mode static --scope full
    • node tools/scripts/cross-agent-packager.js --agent-pack all
  4. Keep README.md high-level and link to canonical docs-guide pages for deep detail.
  5. Keep generator scripts, generated outputs, and downstream consumers in sync whenever a catalog path or title changes.
Last modified on March 16, 2026