docket/mkdocs.yml at main · docket-dev-org/docket · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# Documentation site configuration.
#
# The repository is readable without this file — every document is plain Markdown and every
# link is relative, so GitHub renders the whole tree correctly. This exists for people who
# prefer a searchable site, and for turning the docs into GitHub Pages with one workflow:
#
#     pip install mkdocs-material && mkdocs serve       # preview at http://127.0.0.1:8000
#     mkdocs build --strict                             # fails on a broken internal link
#
# `--strict` is the point: it is the cheapest way to keep 15 documents mutually consistent.
#
# Note on `docs_dir`: it points at a staged copy of the tree (see tools/build_docs_site.py),
# not at `docs/`, because documents link to files outside `docs/` with paths that must stay
# valid on GitHub (`../ROADMAP.md`, `../spec/docket-receipt-1.md`). Staging keeps one set of
# links working in both places. Build with `make site`, never by calling mkdocs directly.

site_name: Docket
site_description: Every AI agent run gets a docket number — a hard spending cap and a tamper-evident receipt anyone can verify offline.
site_url: https://docket-dev-org.github.io/docket/
repo_url: https://github.com/docket-dev-org/docket
repo_name: docket-dev-org/docket
edit_uri: edit/main/docs/
copyright: Apache-2.0 for code · CC BY 4.0 for the specification

docs_dir: .mkdocs-site


theme:
  name: material
  # `assets/` holds the brand kit; `overrides/main.html` adds the head metadata
  # the theme has no setting for (see the comment in that file).
  custom_dir: overrides
  logo: assets/logo.svg
  favicon: assets/favicon.svg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.suggest
    - toc.follow

extra_css:
  # The brand palette, written over Material's own colour variables. Material
  # emits this after its palette stylesheet, so the values win; see the header
  # comment in the file for why it exists at all.
  - assets/brand.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: README.md
  - Start here:
      - Quickstart: docs/quickstart.md
      - Concepts: docs/concepts.md
      - FAQ: docs/faq.md
  - Using it:
      - CLI reference: docs/cli.md
      - Policy reference: docs/policy-reference.md
      - Response cache: docs/caching.md
      - Integrations: docs/integrations.md
  - Trust:
      - What verification proves: docs/verification.md
      - Threat model and limits: docs/threat-model.md
      - Evidence: docs/evidence.md
      - Incident corpus: docs/incident-corpus.md
      - Format specification: spec/docket-receipt-1.md
      - Conformance (normative): spec/conformance.md
      - Check-id registry: spec/registry.json
  - Project:
      - Architecture: docs/architecture.md
      - Testing: docs/testing.md
      - Measurements (one host, 2026-10-15): docs/measurements/2026-10-15-2core/README.md
      - Resilience: docs/resilience.md
      - Deployment: docs/deployment.md
      - Deploy recipes: deploy/README.md
      - Production coverage: docs/production-coverage.md
      - Resilience practice coverage: docs/sre-coverage.md
      - Standards and papers behind the mechanisms: docs/standards.md
      - Comparison: docs/comparison.md
      - Changelog: CHANGELOG.md
      - Roadmap: ROADMAP.md
      - Governance: GOVERNANCE.md
      - Maintainers: MAINTAINERS.md
      - Contributors: CONTRIBUTORS.md
      - Code of conduct: CODE_OF_CONDUCT.md
      - Contributing: CONTRIBUTING.md
      - Publishing: PUBLISHING.md
      - Security policy: SECURITY.md
      - Support: SUPPORT.md
      - Supporting Docket: SPONSORS.md
      - Decisions (ADRs):
          - 0001 Record format decisions as ADRs: docs/adr/0001-record-format-decisions-as-adrs.md
          - 0002 No floating point in hashed structures: docs/adr/0002-no-floating-point-in-hashed-structures.md
          - 0003 Verification uses recomputed hashes: docs/adr/0003-verification-uses-recomputed-hashes.md
          - 0004 Content snapshots and confinement: docs/adr/0004-content-snapshots-and-confinement.md
          - 0005 One writer at a time: docs/adr/0005-concurrency-and-one-writer-at-a-time.md
          - 0006 The shape of the conformance corpus: docs/adr/0006-the-shape-of-the-conformance-corpus.md
          - 0007 Members a receipt states about its own rows: docs/adr/0007-the-members-a-receipt-states-about-itself.md
          - 0008 A third implementation from the spec alone: docs/adr/0008-a-third-implementation-written-from-the-spec.md
  - Examples:
      - Examples index: examples/README.md
      - Quickstart example: examples/quickstart/README.md
      - CI example: examples/ci/README.md
      - Client deliverable: examples/client-deliverable/README.md
      - Subscription mode: examples/subscription/README.md
      - Custom agent (policy + script): examples/custom-agent/README.md