Skip to content

Commit 09e7023

Browse files
docs(wikis): scaffold audience-split education layer (Users/Developers/Maintainers) (#398)
## What Adds `docs/wikis/` — a long-form, **audience-segmented education layer** for `standards`, deeper than the `QUICKSTART-*.adoc` setup guides. Follow-up to the #397 close-out (the staleness work), addressing the gap that `standards` had **no education layer beyond quickstart and no wiki mirror**. Follows the estate pattern already used in `k9-svc/*/docs/wikis/` (audience split + machine manifest). ## Contents - `docs/wikis/README.adoc` — wiki home + audience routing + format/sync rules. - `docs/wikis/{users,developers,maintainers}/index.adoc` — three learning paths. Each is a **complete link spine** into the canonical docs (README, EXPLAINME, CLAUDE.md, the ADRs, the policies, the registry) with explicit `TODO` markers where prose still needs writing — an honest scaffold, not an empty stub. - `docs/wikis/0.2-AI-MANIFEST.a2ml` — machine mirror of the track (so it's in **both** human and machine docs). - `README.adoc` + `0-AI-MANIFEST.a2ml` — each gains an "education layer" front-door row. ## Audience split - **Users** — consuming/adopting the standards (reusable workflows incl. the pin-freshness window from ADR-003, A2ML, readiness grades). - **Developers** — building to the standards (language policy, A2ML/K9 authoring, Hypatia rules, the CI gates). - **Maintainers** — evolving the standards (registry generator, the licence Manual-Only guardrail, drift/staleness automation, the 6a2/contractile stack). ## Notes - Registry + topology stay in sync (`docs/` is not a spec home — verified). - SPDX from birth: `CC-BY-SA-4.0` for the `.adoc` docs (matching the existing docs), `MPL-2.0` for the `.a2ml` manifest. - Full per-track prose is intentionally deferred — tracked as a follow-up issue (the docs/wiki education audit). - The pre-existing estate-wide Hypatia checks (`governance` / `hypatia-scan`) are red on `main` independently of this PR; this change is docs-only. Kept **draft** pending review of structure/scope before the prose is written. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01BKyi8Bht8xdXyajpkaTdYP --- _Generated by [Claude Code](https://claude.ai/code/session_01BKyi8Bht8xdXyajpkaTdYP)_ Co-authored-by: Claude <noreply@anthropic.com>
1 parent 42455b1 commit 09e7023

7 files changed

Lines changed: 298 additions & 0 deletions

File tree

0-AI-MANIFEST.a2ml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ content-addressed `source_hash`. Prose explanation: `REGISTRY.adoc`.
2929
| Drift / staleness automation | `REGISTRY.adoc`, `hypatia-rules/` (HYP-S006); reusable-pin freshness: `docs/decisions/ADR-003-workflow-pin-staleness-window.adoc`, `scripts/check-workflow-staleness.sh`, `scripts/propagate-workflow-pins.sh` |
3030
| Derived architecture map | `TOPOLOGY.md` (generated — do not edit) |
3131
| Current project state | `.machine_readable/6a2/STATE.a2ml` |
32+
| Education layer (deep docs, by audience) | `docs/wikis/` (Users / Developers / Maintainers); machine mirror `docs/wikis/0.2-AI-MANIFEST.a2ml` |
3233

3334
## CANONICAL LOCATIONS (UNIVERSAL RULE)
3435

README.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ Every other "what is this repo" doc is now a thin pointer back to these two
6161

6262
| To **stand up a new repo** to these standards
6363
| link:A2ML-REPO-TEMPLATE.adoc[A2ML-REPO-TEMPLATE.adoc] + <<Usage>>
64+
65+
| The **education layer** — audience-split deep docs (beyond quickstart)
66+
| link:docs/wikis/[docs/wikis/] — link:docs/wikis/users/index.adoc[Users] · link:docs/wikis/developers/index.adoc[Developers] · link:docs/wikis/maintainers/index.adoc[Maintainers]
6467
|===
6568

6669
NOTE: link:.machine_readable/REGISTRY.a2ml[REGISTRY.a2ml] and

docs/wikis/0.2-AI-MANIFEST.a2ml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# SPDX-License-Identifier: MPL-2.0
2+
# SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
3+
#
4+
# Machine pointer for the standards education layer (the wiki track).
5+
# Human entry: docs/wikis/README.adoc. This file mirrors that structure so an
6+
# agent can route a "teach me X for audience Y" request without scraping prose.
7+
8+
id: "wikis-track"
9+
status: "scaffold"
10+
version: "0.1.0"
11+
updated: "2026-06-21"
12+
13+
description: >
14+
Audience-segmented, long-form education layer for hyperpolymath/standards.
15+
Deeper than the QUICKSTART-*.adoc files (which cover setup + basic run): the
16+
wiki teaches the model, the why, and how to engage fully.
17+
18+
format:
19+
primary: "asciidoc" # estate doc policy; no .md duplicates
20+
source_of_truth: "in-repo" # synced OUT to any forge wiki, never hand-edited there
21+
22+
front_doors:
23+
human: "README.adoc"
24+
machine: "0-AI-MANIFEST.a2ml"
25+
verifiable_index: ".machine_readable/REGISTRY.a2ml"
26+
27+
tracks:
28+
- audience: "users"
29+
home: "docs/wikis/users/index.adoc"
30+
quickstart: "QUICKSTART-USER.adoc"
31+
for: "consuming / adopting the standards (reusable workflows, A2ML, grades)"
32+
- audience: "developers"
33+
home: "docs/wikis/developers/index.adoc"
34+
quickstart: "QUICKSTART-DEV.adoc"
35+
for: "building to the standards; authoring A2ML/K9; writing Hypatia rules"
36+
- audience: "maintainers"
37+
home: "docs/wikis/maintainers/index.adoc"
38+
quickstart: "QUICKSTART-MAINTAINER.adoc"
39+
for: "evolving the standards: registry generator, guardrails, drift automation"
40+
41+
todo:
42+
- "Flesh out per-track core-concept prose beyond the link spine"
43+
- "Decide forge-wiki vs in-repo-only hosting"
44+
- "Add glossary + per-track worked examples"

docs/wikis/README.adoc

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
3+
= Standards Wiki — the education layer
4+
:toc:
5+
:toc-placement: preamble
6+
:status: Scaffold v0.1.0 (2026-06-21)
7+
8+
This directory is the **long-form, audience-segmented education layer** for
9+
`hyperpolymath/standards`. It is deliberately *deeper* than the
10+
`QUICKSTART-*.adoc` files: those get you set up and running; these explain the
11+
*why*, the model, and how to engage with the materials fully.
12+
13+
[IMPORTANT]
14+
====
15+
*Status: scaffold.* This is a starting skeleton (standards#docs-wiki-audit).
16+
Each track below has a structured learning path and links to the canonical
17+
sources, with `TODO` markers where prose still needs writing. It is honest
18+
about being incomplete — contributions fill the gaps, they do not start from
19+
zero.
20+
====
21+
22+
== The two front doors (unchanged)
23+
24+
The wiki does not replace the canonical front doors — it *teaches* them:
25+
26+
* Human front door: `README.adoc`
27+
* Machine front door: `0-AI-MANIFEST.a2ml`
28+
* Verifiable index of every spec: `.machine_readable/REGISTRY.a2ml`
29+
30+
== Tracks by audience
31+
32+
[cols="1,3,1",options="header"]
33+
|===
34+
| Track | For whom | Start
35+
36+
| link:users/index.adoc[Users]
37+
| People *consuming / adopting* the standards in their own repos — reusable
38+
workflows, A2ML artefacts, the policies, the readiness grades.
39+
| link:../../QUICKSTART-USER.adoc[QUICKSTART-USER]
40+
41+
| link:developers/index.adoc[Developers]
42+
| People *building to* the standards, or extending the tooling — language
43+
policy, A2ML/K9 authoring, Hypatia rules, the CI gates.
44+
| link:../../QUICKSTART-DEV.adoc[QUICKSTART-DEV]
45+
46+
| link:maintainers/index.adoc[Maintainers]
47+
| People *evolving* this repo — the registry generator, the guardrails, the
48+
licence policy, the drift/staleness automation, the innervation stack.
49+
| link:../../QUICKSTART-MAINTAINER.adoc[QUICKSTART-MAINTAINER]
50+
|===
51+
52+
== Format & sync rules
53+
54+
* Primary format is **AsciiDoc (`.adoc`)** (estate doc policy; no `.md`
55+
duplicates).
56+
* The machine mirror of this track is `0.2-AI-MANIFEST.a2ml` in this
57+
directory — keep it in step when tracks are added.
58+
* If/when a forge-hosted wiki (GitHub/GitLab) is adopted, this directory is
59+
the source of truth and is synced *out* to the forge, never hand-edited
60+
there. (Mirrors the estate pattern in `k9-svc/*/docs/wikis/`.)
61+
62+
== TODO (scaffold → complete)
63+
64+
* [ ] Flesh out each track's "core concepts" prose beyond the link lists.
65+
* [ ] Decide forge-wiki vs in-repo-only hosting.
66+
* [ ] Add a "glossary" page (A2ML, K9, RSR, CRG, contractile, innervation, 6a2).
67+
* [ ] Add worked examples per track (adopt a repo / write a rule / cut a change).

docs/wikis/developers/index.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
3+
= Developers track — building to the standards
4+
:toc:
5+
:toc-placement: preamble
6+
:status: Scaffold v0.1.0 (2026-06-21)
7+
8+
For developers writing repos, tools, or rules that must **comply with** and
9+
**extend** the standards. You author code/metadata that the gates will judge.
10+
11+
NOTE: Scaffold. The link spine is complete; the connective prose is `TODO`.
12+
13+
== Learning path
14+
15+
=== 1. The language policy (read first)
16+
17+
* `.claude/CLAUDE.md` (canonical) — allowed/banned languages, the AffineScript
18+
stance, the carve-out tables (TS/ReScript/npm/JS exemptions).
19+
* TODO: "choosing a language for a new component" decision flow.
20+
21+
=== 2. Build system
22+
23+
* Mustfile / `justfile` (no Makefiles): https://github.com/hyperpolymath/mustfile
24+
* `Justfile` here — `just --list`; package mgmt via Guix → Nix → Deno.
25+
* TODO: "wire a new sub-project into the monorepo build/test".
26+
27+
=== 3. Author the machine-readable metadata
28+
29+
* A2ML family: `a2ml/`, the `*-a2ml/` homes, `a2ml-templates/`.
30+
* K9 self-validating components: `k9-svc/`, `k9-coordination-protocol/`.
31+
* TODO: "write a valid STATE/META set and pass Validate A2ML".
32+
33+
=== 4. The protocols
34+
35+
* `avow-protocol/`, `axel-protocol/`, `overlay-protocol/`,
36+
`consent-aware-http/`, `0-ai-gatekeeper-protocol/`.
37+
* TODO: per-protocol "when would I implement this" summary.
38+
39+
=== 5. Write & extend Hypatia rules
40+
41+
* `hypatia-rules/` (e.g. HYP-S006 `registry-staleness`) — the estate-side
42+
detection rules and the hybrid automation router (`:auto_execute` vs
43+
`:review`, with licence findings capped to `:review`).
44+
* TODO: "anatomy of a rule + how to add one".
45+
46+
=== 6. The CI gates (what blocks a bad change)
47+
48+
* `.github/workflows/` + `hooks/`.
49+
* The workflow-pin staleness gate: `scripts/check-workflow-staleness.sh`
50+
(recency window — link:../../decisions/ADR-003-workflow-pin-staleness-window.adoc[ADR-003]).
51+
* Registry/topology sync, language policy, no-JS, secret scanning, SPARK gate.
52+
* TODO: "decode a red gate and the fastest green path".
53+
54+
=== 7. Reference
55+
56+
* `QUICKSTART-DEV.adoc`, `llm-warmup-dev.md`, `CONTRIBUTING.md`,
57+
`docs/decisions/` (ADRs), `docs/*-POLICY.adoc`.

docs/wikis/maintainers/index.adoc

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
3+
= Maintainers track — evolving the standards
4+
:toc:
5+
:toc-placement: preamble
6+
:status: Scaffold v0.1.0 (2026-06-21)
7+
8+
For maintainers of **this repo** — the people who change the standards, run
9+
the generators, and uphold the guardrails. Highest blast radius; read the
10+
guardrails before touching anything.
11+
12+
NOTE: Scaffold. The link spine is complete; the connective prose is `TODO`.
13+
14+
== Guardrails (non-negotiable, read first)
15+
16+
=== Licence is Manual-Only for agents
17+
18+
* `.claude/CLAUDE.md` (§License Policy) + `LICENCE-POLICY.adoc`.
19+
* Never sweep SPDX/licence headers; licence-drift findings are *flag-only*.
20+
New files may carry correct SPDX from birth, matching the repo's
21+
classification. (Root cause: neurophone#99.)
22+
* TODO: the five-way classification cheat-sheet (MPL / ARR / AGPL / forks / PMPL).
23+
24+
=== Generated files are never hand-edited
25+
26+
* `.machine_readable/REGISTRY.a2ml` and `TOPOLOGY.md` are *generated* by
27+
`scripts/build-registry.sh` (`just registry`); edit the `SPECS` table in the
28+
generator, then regenerate. CI `registry-verify.yml` fails on drift.
29+
* TODO: "add a new spec home end-to-end".
30+
31+
== Learning path
32+
33+
=== 1. The registry + topology pipeline
34+
35+
* `scripts/build-registry.sh`, `just registry` / `just registry-check`,
36+
`REGISTRY.adoc`, `TOPOLOGY.md` (derived).
37+
38+
=== 2. Drift / staleness automation
39+
40+
* HYP-S006 `registry-staleness` (`hypatia-rules/`) — the time-window idiom.
41+
* Reusable-pin freshness: link:../../decisions/ADR-003-workflow-pin-staleness-window.adoc[ADR-003],
42+
`scripts/check-workflow-staleness.sh`, `scripts/propagate-workflow-pins.sh`.
43+
* Deferred cross-repo auto-bump: `docs/FUTURE-WORK.adoc` (#16).
44+
45+
=== 3. Readiness-grade governance
46+
47+
* `component-readiness-grades/` (+ ARG/FRG/TRG), `CRG-SELF-ASSESSMENT.adoc`,
48+
the demotion/overclaim detectors in `hypatia-rules/`.
49+
50+
=== 4. Decision records & policy
51+
52+
* `docs/decisions/` (ADR process), the `*-POLICY.adoc` set
53+
(DEPENDABOT, TRUSTED-BASE, REMOTE-URL, CODEOWNERS, TOOLING-VERSION-INTEGRITY).
54+
* TODO: "when to write an ADR vs a policy".
55+
56+
=== 5. The innervation / contractile stack (6a2)
57+
58+
* `.machine_readable/6a2/` (STATE/META/…), `contractiles/`, `contractile.just`,
59+
`coordination.k9`, `.verisimdb/`, and Hypatia as the estate-side analyser.
60+
* TODO: "how a contractile is registered and fires"; whether estate scripts
61+
(e.g. the staleness/propagation pair) should be registered as contractiles.
62+
63+
=== 6. Release & ownership
64+
65+
* `release-pre-flight/`, `publication-pre-flight/`, `just v1-audit`,
66+
`MAINTAINERS.adoc`, `CODEOWNERS-POLICY.adoc`, `SECURITY.md`.

docs/wikis/users/index.adoc

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
3+
= Users track — consuming & adopting the standards
4+
:toc:
5+
:toc-placement: preamble
6+
:status: Scaffold v0.1.0 (2026-06-21)
7+
8+
For repo owners and teams who **adopt** the Hyperpolymath standards or
9+
**consume** their outputs (reusable workflows, A2ML metadata, policies,
10+
readiness grades). You are not editing the standards themselves — you are
11+
applying them.
12+
13+
NOTE: Scaffold. The link spine is complete; the connective prose is `TODO`.
14+
15+
== Learning path
16+
17+
=== 1. Orient — what *are* these standards?
18+
19+
* `README.adoc` (§Overview) — the human front door.
20+
* `EXPLAINME.adoc` — the architecture-decisions narrative.
21+
* TODO: one-paragraph "standards in plain language" for newcomers.
22+
23+
=== 2. The machine-readable artefacts (6a2)
24+
25+
Every Hyperpolymath repo carries six A2ML files (`STATE`, `META`, `ECOSYSTEM`,
26+
`AGENTIC`, `NEUROSYM`, `PLAYBOOK`) plus `ANCHOR`.
27+
28+
* Canonical layout + meaning: `0-AI-MANIFEST.a2ml` (§CANONICAL LOCATIONS).
29+
* TODO: "what each artefact is for, as a consumer reading someone else's repo".
30+
31+
=== 3. Adopt the standards in your repo
32+
33+
* `A2ML-REPO-TEMPLATE.adoc` — the template to stand a repo up.
34+
* `setup.sh` — bootstrap.
35+
* `TEMPLATE-APPLICABILITY-POLICY.adoc` — which parts apply to which repo shapes.
36+
* TODO: a 10-minute "adopt on an existing repo" worked example.
37+
38+
=== 4. Consume the reusable workflows
39+
40+
Standards hosts reusable CI workflows you pin by SHA
41+
(`governance-reusable.yml`, `hypatia-scan-reusable.yml`,
42+
`scorecard-reusable.yml`, …).
43+
44+
* How pinning + *pin freshness* works — and why your CI no longer reds on
45+
every standards commit: link:../../decisions/ADR-003-workflow-pin-staleness-window.adoc[ADR-003].
46+
* Bumping a pin deliberately: `scripts/propagate-workflow-pins.sh` (audit-first).
47+
* TODO: copy-paste consumer workflow snippets per reusable.
48+
49+
=== 5. Readiness grades — reading the labels
50+
51+
ARG / FRG / CRG / TRG tell you how mature a repo/component is.
52+
53+
* `adoption-readiness-grades/`, `foundations-readiness-grades/`,
54+
`component-readiness-grades/`, `toolchain-readiness-grades/`.
55+
* TODO: "how to read a grade badge and what it promises you".
56+
57+
=== 6. Get help
58+
59+
* `QUICKSTART-USER.adoc`, `llm-warmup-user.md`.
60+
* Issues: https://github.com/hyperpolymath/standards/issues

0 commit comments

Comments
 (0)