mkdocs.yml

site_name: gzkit
site_url: https://gzkit.org
site_description: "Keep humans in the loop when AI writes your code"
site_author: g0
docs_dir: docs

repo_url: https://github.com/tvproductions/gzkit
repo_name: tvproductions/gzkit

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.follow
    - content.code.copy
  font:
    text: Inter
    code: JetBrains Mono

nav:
  - Home: user/index.md
  - Quickstart: user/quickstart.md
  - Runbook: user/runbook.md
  - Why gzkit?: user/why.md
  - Examples:
    - Overview: examples/index.md
    - Tutorials:
      - First Project: examples/tutorial-first-project.md
      - RHEA Bootstrap: examples/tutorial-rhea-bootstrap.md
    - Guides:
      - PRD Guide: examples/guide-prd.md
      - ADR Guide: examples/guide-adr.md
      - Task Guide: examples/guide-tasks.md
      - Releasing Guide: examples/guide-releasing.md
    - Templates:
      - PRD Template: examples/templates/prd-template.md
      - ADR Template: examples/templates/adr-template.md
      - Task Template: examples/templates/task-template.md
    - Assessments:
      - Glossary: examples/glossary.md
      - GZKit Readiness Assessment: examples/gzkit-readiness-assessment.md
      - Go-Live Gap Analysis: examples/go-live-gap-analysis.md
      - Framework Comparison: examples/comparison-gzkit-speckit-bmad.md
  - Concepts:
    - Gates: user/concepts/gates.md
    - Lanes: user/concepts/lanes.md
    - Lifecycle: user/concepts/lifecycle.md
    - ADR Taxonomy: user/concepts/adr-taxonomy.md
    - Foundation/Feature Invariance Test: user/concepts/foundation-feature-invariance-test.md
    - OBPIs: user/concepts/obpis.md
    - Closeout Ceremony: user/concepts/closeout.md
    - Daily Workflow: user/concepts/workflow.md
    - Test Traceability: user/concepts/test-traceability.md
  - Skills:
    - Overview: user/skills/index.md
    - Project Setup:
      - /gz-init: user/skills/gz-init.md
      - /gz-prd: user/skills/gz-prd.md
      - /gz-constitute: user/skills/gz-constitute.md
      - /gz-design: user/skills/gz-design.md
      - /gz-rnd: user/skills/gz-rnd.md
    - Planning:
      - /gz-plan: user/skills/gz-plan.md
      - /gz-adr-create: user/skills/gz-adr-create.md
      - /gz-obpi-specify: user/skills/gz-obpi-specify.md
      - /gz-adr-evaluate: user/skills/gz-adr-evaluate.md
      - /gz-plan-audit: user/skills/gz-plan-audit.md
    - Execution:
      - /gz-obpi-pipeline: user/skills/gz-obpi-pipeline.md
      - /gz-implement: user/skills/gz-implement.md
      - /gz-check: user/skills/gz-check.md
      - /gz-arb: user/skills/gz-arb.md
      - /gz-complexity-advisor: user/skills/gz-complexity-advisor.md
    - Status & Review:
      - /gz-big-picture: user/skills/gz-big-picture.md
      - /gz-status: user/skills/gz-status.md
      - /gz-adr-status: user/skills/gz-adr-status.md
      - /gz-state: user/skills/gz-state.md
      - /gz-obpi-simplify: user/skills/gz-obpi-simplify.md
      - /gz-adr-map: user/skills/gz-adr-map.md
    - Closeout & Audit:
      - /gz-adr-closeout-ceremony: user/skills/gz-adr-closeout-ceremony.md
      - /gz-adr-audit: user/skills/gz-adr-audit.md
      - /gz-obpi-sync: user/skills/gz-obpi-sync.md
      - /gz-adr-emit-receipt: user/skills/gz-adr-emit-receipt.md
      - /gz-validate: user/skills/gz-validate.md
    - Operations:
      - /git-sync: user/skills/git-sync.md
      - /gz-patch-release: user/skills/gz-patch-release.md
      - /gz-session-handoff: user/skills/gz-session-handoff.md
      - /gz-chore-runner: user/skills/gz-chore-runner.md
      - /gz-obpi-lock: user/skills/gz-obpi-lock.md
      - /gz-cli-audit: user/skills/gz-cli-audit.md
  - Manpages:
    - Overview: user/manpages/index.md
    - gz init: user/manpages/init.md
    - gz prd: user/manpages/prd.md
    - gz constitute: user/manpages/constitute.md
    - gz specify: user/manpages/specify.md
    - gz plan create: user/manpages/plan-create.md
    - gz plan audit: user/manpages/plan-audit.md
    - gz implement: user/manpages/implement.md
    - gz gates: user/manpages/gates.md
    - gz status: user/manpages/status.md
    - gz state: user/manpages/state.md
    - gz adr status: user/manpages/adr-status.md
    - gz adr promote: user/manpages/adr-promote.md
    - gz adr audit-check: user/manpages/adr-audit-check.md
    - gz adr fidelity: user/manpages/adr-fidelity.md
    - gz adr covers-check: user/manpages/adr-covers-check.md
    - gz adr emit-receipt: user/manpages/adr-emit-receipt.md
    - gz covers: user/manpages/covers.md
    - gz flags: user/manpages/flags.md
    - gz flag explain: user/manpages/flag-explain.md
    - gz obpi status: user/manpages/obpi-status.md
    - gz obpi acceptance: user/manpages/obpi-acceptance.md
    - gz obpi present-evidence: user/manpages/obpi-present-evidence.md
    - gz obpi pipeline: user/manpages/obpi-pipeline.md
    - gz obpi validate: user/manpages/obpi-validate.md
    - gz obpi sync: user/manpages/obpi-sync.md
    - gz obpi brief-drift: user/manpages/obpi-brief-drift.md
    - gz obpi emit-receipt: user/manpages/obpi-emit-receipt.md
    - gz closeout: user/manpages/closeout.md
    - gz patch release: user/manpages/patch-release.md
    - gz audit: user/manpages/audit.md
    - gz git-sync: user/manpages/git-sync.md
    - gz attest: user/manpages/attest.md
    - gz migrate-semver: user/manpages/migrate-semver.md
    - gz register-adrs: user/manpages/register-adrs.md
    - gz chores list: user/manpages/chores-list.md
    - gz chores plan: user/manpages/chores-plan.md
    - gz chores run: user/manpages/chores-run.md
    - gz chores audit: user/manpages/chores-audit.md
    - gz skill audit: user/manpages/skill-audit.md
    - gz parity check: user/manpages/parity-check.md
    - gz readiness audit: user/manpages/readiness-audit.md
    - gz check-config-paths: user/manpages/check-config-paths.md
    - gz cli audit: user/manpages/cli-audit.md
    - gz task list: user/manpages/task-list.md
    - gz task start: user/manpages/task-start.md
    - gz task complete: user/manpages/task-complete.md
    - gz task block: user/manpages/task-block.md
    - gz task escalate: user/manpages/task-escalate.md
    - gz personas list: user/manpages/personas-list.md
    - gz agent sync control-surfaces: user/manpages/agent-sync-control-surfaces.md
  - Governance (Canonical):
    - Governance Runbook: governance/governance_runbook.md
    - State Doctrine: governance/state-doctrine.md
    - Storage Tiers Reference: governance/storage-tiers.md
    - Pipeline Marker Migration Path: governance/pipeline-marker-migration-path.md
    - Documentation Taxonomy: governance/documentation-taxonomy.md
    - Feature Flags: governance/feature-flags.md
    - Pool Curation Policy: governance/pool-curation.md
    - Parity Intake Rubric: governance/parity-intake-rubric.md
    - Command Doctrine: governance/GovZero/command-doctrine.md
    - Charter: governance/GovZero/charter.md
    - ADR Lifecycle: governance/GovZero/adr-lifecycle.md
    - OBPI Transaction Contract: governance/GovZero/obpi-transaction-contract.md
    - OBPI Runtime Contract: governance/GovZero/obpi-runtime-contract.md
    - OBPI Decomposition Matrix: governance/GovZero/obpi-decomposition-matrix.md
    - ADR/OBPI/GHI/Audit Linkage: governance/GovZero/adr-obpi-ghi-audit-linkage.md
    - ADR Status: governance/GovZero/adr-status.md
    - Audit Protocol: governance/GovZero/audit-protocol.md
    - Gate 5 Architecture: governance/GovZero/gate5-architecture.md
    - Architectural Enforcement: governance/GovZero/architectural-enforcement.md
    - Gzkit Structure: governance/GovZero/gzkit-structure.md
    - Governance Registry Design: governance/GovZero/governance-registry-design.md
    - Agent-Era Prompting Summary: governance/GovZero/agent-era-prompting-summary.md
    - Layered Trust: governance/GovZero/layered-trust.md
    - Ledger Schema: governance/GovZero/ledger-schema.md
    - Session Handoff Obligations: governance/GovZero/session-handoff-obligations.md
    - Session Handoff Schema: governance/GovZero/session-handoff-schema.md
    - Handoff Chaining: governance/GovZero/handoff-chaining.md
    - Handoff Validation: governance/GovZero/handoff-validation.md
    - Staleness Classification: governance/GovZero/staleness-classification.md
    - Validation Receipts: governance/GovZero/validation-receipts.md
    - Releases:
      - Overview: governance/GovZero/releases/README.md
      - Major Release: governance/GovZero/releases/major-release.md
      - Minor Release: governance/GovZero/releases/minor-release.md
      - Patch Release: governance/GovZero/releases/patch-release.md
    - Audits:
      - Harmonization Brief: governance/GovZero/audits/AUDIT-BRIEF-governance-harmonization.md
      - Harmonization Audit: governance/GovZero/audits/governance-harmonization-2026-01-11.md
      - Agent Readiness Audit Template: governance/GovZero/audits/AUDIT-TEMPLATE-agent-readiness.md
  - Reference:
    - Docs README: README.md
    - Charter: user/reference/charter.md
    - Lineage: user/reference/lineage.md
    - Agent Input Disciplines: user/reference/agent-input-disciplines.md
    - Genesis: user/reference/genesis.md
    - Genesis Transcript: user/reference/genesis-transcript.md
    - AirlineOps Exploration: user/reference/airlineops-exploration-verbatim.md

exclude_docs: |
  design/**
  proposals/**
  lodestar/**
  developer/**
  rnd/**

validation:
  nav:
    omitted_files: info
  links:
    not_found: ignore
    absolute_links: info
    unrecognized_links: info
    anchors: info

markdown_extensions:
  - tables
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      # auto_title ensures `title` is always a string. Without it,
      # pymdownx.highlight passes filename=None to pygments.HtmlFormatter,
      # which crashes on pygments 2.20.0+ (html.escape(None) fails in the
      # hardened HTML formatter shipped with pygments/pygments#3071). See
      # GHI #281.
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - toc:
      permalink: true
  - attr_list
  - md_in_html

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tvproductions/gzkit

copyright: "The human is index zero."