Skip to main content

Documentation Index

Fetch the complete documentation index at: https://na-36-handover-docs-v2-into-docs-v2-dev-20260518.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Feature Map

This repository is a docs-as-infrastructure system, not a folder of pages. The intended operating model is ownerless: every governed surface should declare its canonical source, validator, repair path, and primary gate so a contributor or agent can diagnose and repair drift without private maintainer context. Use this page as the high-level system map. Use the linked feature pages for implementation details and the gap analysis for purge, migration, and remediation work.

Core Philosophy

PrincipleWhat it means in this repoPrimary evidence
Ownerless governanceA surface is not production-ready unless it has one canonical source, one validator, one repair path, and one primary gate.docs-guide/policies/ownerless-governance.mdx, operations/governance/config/ownerless-governance-surfaces.json
Source of truth before convenienceGenerated outputs, indexes, and registries must be regenerated from canonical inputs rather than hand-edited.docs-guide/policies/source-of-truth-policy.mdx, operations/governance/config/generated-artifacts.json
Root causes over bypassesFailures should be repaired in the policy, generator, source data, or validator that owns the drift. Ignoring files or hiding failures is not sufficient.AGENTS.md, .githooks/, docs-guide/policies/quality-gates.mdx
Layered enforcementFast local checks stay in pre-commit; branch and AI task checks stay in pre-push; broad browser/link/network sweeps belong in CI or scheduled jobs.docs-guide/policies/infrastructure-principles.mdx, operations/tests/WHEN-TESTS-RUN.md
Public docs and repo ops are one productContent, components, data feeds, automation, AI artifacts, and governance docs must evolve together.docs.json, v2/, snippets/, operations/, docs-guide/

Feature Index

Feature areaPurposeMain pageCore surfaces
AI features and pipelinesAgent adapters, skills, AI-public artifacts, AI sitemap, llms.txt, and agent governance.AI FeaturesAGENTS.md, ai-tools/, .claude/, .codex/, .cursor/, .windsurf/, .augment/, llms.txt, sitemap-ai.xml
UI systemComponent taxonomy, templates, snippets, styling, and MDX authoring primitives.UI Systemsnippets/components/, snippets/templates/, .vscode/*.code-snippets, style.css
AutomationsGitHub Actions, scheduled checks, CI gates, dispatchers, remediators, and workflow governance.Automations.github/workflows/, .github/workspace/, operations/scripts/, operations/tests/
Data integrationsOpenAPI specs, contract-address feeds, release data, social/community feeds, exchanges data, and generated reference data.Data Integrationsapi/, snippets/data/, operations/scripts/integrators/, operations/scripts/generators/
Adaptive architectureSelf-remediation model: validators detect drift, remediators repair drift, generators rebuild derived state, and reports identify backlog.Adaptive Architectureoperations/governance/, operations/scripts/remediators/, workspace/reports/, .githooks/
Contributor toolsLocal CLI, hooks, editor extensions, preview tooling, scoped docs configs, and contribution workflows.Contributor Toolstools/lpd, tools/dev/, tools/editor-extensions/, .githooks/, .vscode/
Gap analysisImplementation-ready cleanup and alignment backlog.Gap Analysisv2/, workspace/, docs-guide/features/, operations/scripts/, .github/workflows/

System Map

LayerRuntime roleCanonical sourcesDerived outputsPrimary gates
Navigation and routingDefines the published Mintlify site, versions, tabs, groups, redirects, branding, and route membership.docs.jsonMintlify site, generated docs indexes, route listsoperations/scripts/validators/content/structure/lint-structure.js, lpd test --staged
ContentUser-facing docs, internal docs, legacy docs, and section workspaces.v2/, docs-guide/, frozen v1/docs-index.json, generated catalogs, browser reportsContent validators, page rendering checks, link audits
Components and templatesShared presentation and authoring primitives for MDX pages.snippets/components/, snippets/templates/component registry, component docs, VS Code snippetscomponent validators, template generator tests
DataStructured data consumed by pages and integrator components.api/, snippets/data/, external source configsgenerated API docs, snapshots, feed data, reference mapsOpenAPI reference audit, freshness checks, data-fetch workflows
OperationsScripts, tests, hooks, CI workflows, and repair commands.operations/scripts/, operations/tests/, .github/workflows/, .githooks/reports, generated governance maps, CI artifactspre-commit, PR CI, scheduled workflows
GovernanceMachine-readable policy, surface ownership by contract, root allowlist, generated artifact manifest, approval policy.operations/governance/config/, docs-guide/policies/, docs-guide/frameworks/repo governance maps, root allowlist, compliance reportsgovernance validators, approval labels, hook checks
AI agent layerTool-specific adapters and reusable skills for agents.AGENTS.md, native adapters, ai-tools/ai-skills/agent packs, synced Codex skills, skill indexesagent docs freshness, Codex branch contract checks

Current Inventory Snapshot

As of 2026-05-14, static inspection and repo audit commands found:
InventoryCount or state
Root docs navigation page references1,561 total page references in docs.json
v2 references in nav726 page references
docs-guide references in nav55 page references
Active v2 MDX outside workspaces/design lanes1,125 files
GitHub workflows50 workflow files in .github/workflows/
Operations scripts263 JS/SH/Python files under operations/scripts/, including archive and x-archive lanes
Active JSX components59 JSX files under snippets/components/, including 24 in x-archive/
AI skills34 SKILL.md workflows under ai-tools/ai-skills/
V2 folder cleanup rows307 rows from the v2 folder governance cleanup matrix
Script footprint findings24 findings: 0 critical, 0 high, 4 medium, 20 low

Contributor Operating Loop

  1. Read the relevant governance entry point before editing: start with docs-guide/policies/governance-index.mdx.
  2. Identify the canonical source for the surface being changed.
  3. Change the source, generator, validator, or policy that owns the behavior.
  4. Regenerate derived outputs instead of hand-editing them.
  5. Run the smallest relevant validator, usually lpd test --staged.
  6. If a failure appears, fix the owning source or repair command rather than suppressing the failure.
  7. For route or nav work, treat docs.json as production infrastructure and validate route impact.

What Good Looks Like

Every major feature should satisfy this contract:
RequirementAcceptance check
DiscoverableThe feature has a feature page, framework, policy, catalog entry, or generated registry entry.
GovernedThe canonical source and allowed write paths are documented.
ValidatedA contributor can run a deterministic check locally or in CI.
RepairableThe repair path is exact and does not depend on private knowledge.
BoundedWorkspaces, archives, generated files, and public pages are separated by structure and selection helpers.
PurgeableLegacy paths have explicit migration, archive, or deletion criteria.
Last modified on May 19, 2026