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.

Automations

Automations are the repo’s operating layer. They validate content, generate derived artifacts, ingest external data, repair deterministic drift, and surface cleanup work. The target architecture is ownerless: every automation should be discoverable, classified, bounded, and repairable.

Automation Taxonomy

The live workflow taxonomy is visible in .github/workflows/:
PrefixCountRole
validator-*14Blocking or advisory checks for content, health, governance, discoverability, and maintenance.
generator-*9Regenerate derived artifacts such as AI sitemap, llms files, docs indexes, SDK clients, component registry, catalogs, and action docs.
integrator-*9Pull or update external/internal data feeds, releases, translations, contract addresses, exchanges, and large assets.
interface-*5GitHub issue and review interfaces, including labels, reviewers, linked issues, and Discord intake.
remediator-*5Deterministic repair workflows for brand, frontmatter, style tokens, SEO metadata, and governance pipelines.
audit-*5Scheduled or manual scans for workspace retention, content quality, freshness, links, and page integrity.
dispatch-*3Manual dispatchers for social feeds, post-merge governance sync, and catalog checks.

GitHub Actions Surface

Workflow familyExamplesOwned risk
Content quality and healthvalidator-copy-check-content-quality-suite.yml, validator-health-check-page-rendering.yml, validator-health-check-broken-links.ymlBroken pages, content quality drift, dead links, render failures.
Governancevalidator-governance-check-codex-compliance.yml, validator-governance-check-governance-map.yml, validator-governance-check-workflow-governance.ymlContract drift, stale maps, workflow policy drift.
Discoverabilitygenerator-discoverability-generate-ai-sitemap.yml, generator-discoverability-generate-llms-files.yml, validator-discoverability-check-ai-sitemap.ymlAI/SEO artifacts out of sync with navigation and docs.
Maintenance catalogsgenerator-maintenance-generate-catalogs.yml, validator-maintenance-check-catalogs.yml, validator-maintenance-check-docs-index.ymlGenerated catalogs and docs index drift.
Data feedsintegrator-maintenance-update-release-version.yml, integrator-maintenance-update-contract-addresses.yml, integrator-maintenance-update-exchanges-data.ymlStale structured data rendered in docs.
Contributor interfacesinterface-governance-intake-discord-issues.yml, interface-governance-label-issues.yml, interface-governance-assign-reviewers.ymlIssue intake and review routing.

Script Automation Surface

Operational scripts live in operations/scripts/ and follow the script framework taxonomy:
Type folderLive file countPurpose
audits/22Read-only scans and reports.
generators/31Produce derived files from canonical sources.
validators/51Exit-code checks for hooks, CI, and manual validation.
remediators/29Deterministic repairs to existing files.
dispatch/36Coordinate pipelines and agent/workflow execution.
integrators/58Fetch, transform, or synchronize external and internal data.
interfaces/8GitHub and other contributor-facing integration interfaces.
archive/ and x-archive/23Deprecated or legacy scripts retained for review or compatibility.

Gate Layers

LayerWhat belongs hereWhat does not belong here
Pre-commitFast staged checks, generated artifact drift checks, root structure guardrails, v1 frozen-file guard.Browser sweeps, network calls, long full-site audits.
Pre-pushCodex branch contract, lock checks, issue readiness, branch safety.Style checks already handled by pre-commit or PR CI.
PR CIChanged-file quality, docs-index, OpenAPI references, component and governance checks.Local-only setup checks.
Scheduled CIBroad freshness, links, page integrity, data refresh, and advisory scans.Mutating source files without deterministic PR or repair path.
Manual dispatchOne-off migrations, approvals, repair waves, large data updates.Routine drift that should be covered by a gate.

Ownerless Automation Requirements

Each production automation should declare:
RequirementImplementation target
Canonical sourcePolicy, config, source data, docs tree, or workflow definition that owns truth.
ValidatorLocal or CI command that fails deterministically when drift exists.
Repair commandExact command or workflow that restores derived state.
Primary gateOne layer only: pre-commit, PR changed-file CI, scheduled CI, or manual.
Output contractWhere reports, generated files, or PR comments are written.
Retention policyWhether outputs are committed, archived, summarized, or purged.

Current Automation Gaps

GapEvidenceImplementation action
Stale generated governance mapnode operations/scripts/generators/governance/reports/generate-repo-governance-status.js --check reports docs-guide/repo-ops/config/repo-governance-map.mdx is stale.Regenerate the repo governance map in a focused governance artifact change and rerun the check.
Script metadata complianceScript footprint audit reports 218 scripts marked template non-compliant in workspace/reports/repo-ops/SCRIPT_AUDIT.json.Run the script header repair workflow, then rerun script governance validation.
Archived workflow residue.github/workflows/deprecated/update-blog-data.yml remains tracked.Decide whether this is an intentional compatibility alias or schedule governed deletion with approval.
Feature-doc driftOld automation docs referenced workflow names and tasks/staging/deprecated-n8n/, which is not a current root.Keep this page tied to live workflow prefixes and current operations/scripts/ paths.
  • docs-guide/frameworks/github-actions.mdx
  • docs-guide/frameworks/script-framework.mdx
  • docs-guide/policies/infrastructure-principles.mdx
  • docs-guide/catalog/workflows-catalog.mdx
  • docs-guide/catalog/scripts-catalog.mdx
Last modified on May 19, 2026