Commit 645a80e
Claude/repo tidy rsr taxonomy (#149)
## Summary
Repo-health tidy aligning boj-server's documentation taxonomy with
`hyperpolymath/rsr-template-repo`. The root went from 17 .md/.adoc docs
to **9** (all of which are either GitHub-required, load-bearing, or
known high-coupling items deferred for separate work); `docs/` now has
audience-targeted subdirectories matching the template (`quickstarts/`,
`wikis/`, `architecture/`, `status/`, `developer/`); and every
non-GitHub-required `.md` doc in the moved set is now `.adoc` per the
hyperpolymath language policy.
## Changes — six logical commits
**1. `docs(taxonomy): move root .adoc docs under docs/<category>/`** — 8
root `.adoc` files relocated:
- `EXPLAINME.adoc` → `docs/EXPLAINME.adoc`
- `BOJ_LOGIC.adoc`, `NeSy_SERVERS.adoc` → `docs/architecture/`
- `FUTURE_PLANS.adoc`, `ROADMAP.adoc` → `docs/status/`
- `QUICKSTART-{USER,DEV,MAINTAINER}.adoc` →
`docs/quickstarts/{USER,DEV,MAINTAINER}.adoc`
Cross-refs updated in `0-AI-MANIFEST.a2ml`, `Justfile`,
`elixir/boj-rest.service`,
`.machine_readable/agent_instructions/methodology.a2ml`,
`docs/README.adoc`, `docs/accessibility/README.adoc`, and the two
`outreach/` drafts.
**2. `docs(readme): merge README.md into README.adoc, drop the .md
duplicate`** — the substantive 518-line `README.md` (11-client install
matrix, collapsible cartridge tables, AAA section) converted to AsciiDoc
and merged with the unique sections from the shorter `.adoc` (Features
bullets, Formal verification). `README.md` deleted. Refs in `jsr.json`,
`mcp-bridge/lib/resources.js`, `.github/SECURITY.md`, and `Intentfile`
repointed at `README.adoc`.
**3. `docs(taxonomy): convert wiki/llm-warmup/Phase-3B docs to .adoc and
re-home them`** — five wiki pages converted and moved from `docs/wiki/`
to `docs/wikis/` (template's spelling); `llm-warmup-{dev,user}.md` moved
into `docs/developer/`; `CARTRIDGE-PHASE-3B-COMPLETION.md` moved into
`docs/status/`. Also drift-fixed `STATE.a2ml`'s stale cartridge counts
(`112 → 125`, derived from actual directory count).
**4. `docs(taxonomy): convert docs/*.md to .adoc, relocate
ARCHITECTURE+DEVELOPERS, add subdir READMEs`** — 8 `docs/*.md` files
converted to `.adoc`; `docs/ARCHITECTURE.md` →
`docs/architecture/README.adoc`; `docs/DEVELOPERS.md` →
`docs/developer/README.adoc`. **99 files cross-rewritten** (55 cartridge
READMEs + governance/wiki/dev/architecture refs + `Justfile`,
`.github/copilot-instructions.md`, `SECURITY.md`,
`src/abi/Boj/Catalogue.idr`, `k8s/service.yaml`,
`mcp-bridge/lib/api-clients.js`, etc.). New subdir orientation READMEs
in `docs/quickstarts/`, `docs/status/`, `docs/wikis/`.
**5. `docs(quickstarts): replace stub DEV/MAINTAINER with the
substantial docs/*.md content`** — the substantive `docs/QUICKSTART.md`
(72 lines), `docs/GETTING-STARTED.md` (198 lines), and
`docs/OPERATOR-QUICKSTART.md` (296 lines) replace the 39/40-line stubs
that had moved over from root in commit 1. Result:
`docs/quickstarts/{USER, DEV, BUILD-FROM-SOURCE, MAINTAINER}.adoc`.
**6. `docs(index): comprehensive docs/README.adoc rewrite + final
TYPED-WASM-MCP-BRIDGE conversion`** — `docs/README.adoc` rewritten in
full (four sections: "Reading order by audience", "Directory taxonomy",
"Standalone `docs/` root files", "Related root-level files"). Last lone
`.md` in `docs/architecture/` converted.
## Known-deferred (not in this PR — high coupling)
These four root-level files are intentionally left in place because
moving them would ripple across 5–16+ files including CI workflows,
Idris2 proofs, and Elixir test fixtures:
- `PROOF-NEEDS.md` (16 cross-refs, incl.
`.github/workflows/backend-assurance.yml`,
`src/abi/Boj/SafetyLemmas.idr`, 4 Elixir test files)
- `TOPOLOGY.md` (11 cross-refs, incl. a CI workflow)
- `TEST-NEEDS.md` (5 cross-refs)
- `GEMINI.md` — *not* deferred; it's load-bearing
(`gemini-extension.json` references it as `contextFileName`)
A follow-up PR can address the first three with a careful bulk-rewrite
once these moves are accepted.
## Issues + PRs
Verified all 6 open issues (#135, #111, #101, #100, #87, #67) are
current — most recently updated 2026-05-20. No stale issues require
closing.
## Cartridge-count drift
`.machine_readable/6a2/STATE.a2ml` had `cartridges-total = 112` but the
actual count is **125** (every cartridge directory has
`cartridge.json`). Bumped: `cartridges-total 112 → 125`,
`cartridges-with-zig-ffi 111 → 115` (manifest-counted),
`cartridges-with-js-mod 111 → 113`, and the prose in
`[project-context].purpose`.
## Test plan
- [x] All cross-references rewritten in the same commits as the file
moves (no dangling links). Verified via `git grep -l <old-path>`
returning 0 for every moved file.
- [x] CHANGELOG.md and historical log entries inside
`.machine_readable/6a2/STATE.a2ml` deliberately left intact (rewriting
history obscures the audit trail).
- [ ] CI is freshly running (26 checks queued from this push).
- [ ] Reviewer spot-check: `docs/README.adoc` index accurately reflects
the on-disk taxonomy.
- [ ] Reviewer spot-check: at least one cartridge README (e.g.
`cartridges/aerie-mcp/README.adoc`) still links cleanly to
`docs/READINESS.adoc`.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent ad3224c commit 645a80e
137 files changed
Lines changed: 5136 additions & 3322 deletions
File tree
- .github
- DISCUSSION_TEMPLATE
- .machine_readable
- 6a2
- agent_instructions
- servers
- cartridges
- aerie-mcp
- agent-mcp
- bsp-mcp
- burble-admin-mcp
- civic-connect-mcp
- claude-agents-power-mcp
- claude-ai-mcp
- cloud-mcp
- coderag-mcp
- codeseeker-mcp
- comms-mcp
- conflow-mcp
- container-mcp
- dap-mcp
- database-mcp
- dns-shield-mcp
- fleet-mcp
- game-admin-mcp
- git-mcp
- gossamer-mcp
- hypatia-mcp
- ffi
- iac-mcp
- idaptik-admin-mcp
- k8s-mcp
- kategoria-mcp
- laminar-mcp
- lang-mcp
- local-memory-mcp
- lsp-mcp
- ml-mcp
- model-router-mcp
- nesy-mcp
- notifyhub-mcp
- observe-mcp
- opendatamcp
- opsm-mcp
- origenemcp
- panic-attack-mcp
- pmpl-mcp
- proof-mcp
- queues-mcp
- reposystem-mcp
- research-mcp
- secrets-mcp
- ssg-mcp
- stapeln-mcp
- toolchain-mcp
- typed-wasm-mcp
- ums-mcp
- verisimdb-mcp
- vext-mcp
- vordr-mcp
- docs
- accessibility
- architecture
- decisions
- developer
- examples
- governance
- outreach
- practice
- quickstarts
- status
- wikis
- wiki
- elixir
- ffi/zig/src
- k8s
- mcp-bridge/lib
- src/abi
- Boj
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
364 | 364 | | |
365 | 365 | | |
366 | 366 | | |
367 | | - | |
| 367 | + | |
368 | 368 | | |
369 | 369 | | |
370 | 370 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
107 | | - | |
| 107 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
299 | 299 | | |
300 | 300 | | |
301 | 301 | | |
302 | | - | |
| 302 | + | |
303 | 303 | | |
304 | 304 | | |
305 | 305 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 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 | + | |
30 | 69 | | |
31 | 70 | | |
32 | 71 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
0 commit comments