Commit eed4250
docs: add ToCs + clear obsolete SPDX-normalization follow-up note (#151)
## Summary
Three small docs follow-ups bundled into one PR:
- **`README.md`** — adds a manual markdown Contents section after the
badges block, mirroring the Axiom.jl-style top-of-file ToC pattern
- **`readme.adoc`** — adds `:toc:` + `:toclevels: 2` macros
- **`EXPLAINME.adoc`** — adds `:toc:` + `:toclevels: 2` macros (was
missing — the other audience-facing `.adoc` files already had `:toc:`)
- **`README.md`** + **`readme.adoc`** — drop the "current practical
follow-up" licensing bullet (the SPDX-header normalization it referenced
just landed in #150, so the line is now obsolete) and tighten the
remaining bullets from "intended to be licensed" → "licensed"
`QUICKSTART-DEV.adoc` / `QUICKSTART-MAINTAINER.adoc` /
`QUICKSTART-USER.adoc` / `INDEX.adoc` / `TOPOLOGY.adoc` already carry
`:toc:` so are unchanged.
## Test plan
- [ ] CI passes
- [ ] `README.md` Contents links resolve correctly on GitHub
- [ ] `readme.adoc` + `EXPLAINME.adoc` ToCs render in any AsciiDoc
viewer
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 7eb621e commit eed4250
3 files changed
Lines changed: 29 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
| 5 | + | |
4 | 6 | | |
5 | 7 | | |
6 | 8 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
18 | 39 | | |
19 | 40 | | |
20 | 41 | | |
| |||
446 | 467 | | |
447 | 468 | | |
448 | 469 | | |
449 | | - | |
450 | | - | |
451 | | - | |
| 470 | + | |
| 471 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
| 4 | + | |
| 5 | + | |
4 | 6 | | |
5 | 7 | | |
6 | 8 | | |
| |||
284 | 286 | | |
285 | 287 | | |
286 | 288 | | |
287 | | - | |
288 | | - | |
289 | | - | |
| 289 | + | |
| 290 | + | |
0 commit comments