Commit d89df46
committed
docs: number the chapters by band, and write the design the reorganisation was missing
Two things, and the second is the one that matters.
The chapters are renumbered so the number says which part a chapter is in: 0x
uses mcpp, 1x ships what was built, 2x is toolchains and targets, 3x is bare
metal and devices, 5x is the machine-facing contracts, 9x is mcpp itself. Within
a part the order is a reading order. The index read `00, 01, 05, 06, 07, 21, 22`
under Part I, which is a list a reader cannot sort. Renumbering was refused in
the previous batch on a measurement that counted 103 citing files; 73 of those
are `.agents/docs` design records, where citing the number a chapter had at the
time is correct. The live cost is 29 files and 56 occurrences, plus 287
intra-docs links, all scripted -- and the earlier refusal conflated an immutable
record with live code.
The second thing is `.agents/docs/2026-09-08-the-documentation-as-a-book.md`. A
reorganisation groups the chapters that exist; it does not decide what each one
is FOR. Measured: testing is a section in seven chapters, dependency resolution
in seven, C++ modules in seven, and the model -- what mcpp's moving parts are --
is a section in none. Five of 24 chapters state their reader and their question;
six have a limits section.
So the design specifies, per chapter, the reader, the one question it answers,
what it contains, what it must NOT contain, where it sits and why. It creates
three chapters for the three unowned topics, moves build programs beside rule
authoring because they are one subject at two scales, moves bare metal in front
of devices because that is the arc, and states the rule that keeps a topic from
being explained a second time.
That implies a second renumbering, which is the cost of having reorganised
before designing. It is stated in the design rather than hidden.1 parent 4774e81 commit d89df46
83 files changed
Lines changed: 724 additions & 395 deletions
File tree
- .agents/docs
- .github
- tools
- workflows
- docs
- specs
- zh
- examples
- 06-openkal-cross
- 09-heterogeneous
- cuda/app
- modules
- manifest/src
- toolchain-model/src
- versioning/src
- src
- build
- pack
- pm
- publish
- toolchain
- tests
- e2e
- unit
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
35 | 36 | | |
| 37 | + | |
36 | 38 | | |
37 | 39 | | |
38 | 40 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
139 | | - | |
| 139 | + | |
140 | 140 | | |
141 | 141 | | |
142 | 142 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
| 58 | + | |
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
677 | 677 | | |
678 | 678 | | |
679 | 679 | | |
680 | | - | |
| 680 | + | |
681 | 681 | | |
682 | 682 | | |
683 | 683 | | |
| |||
779 | 779 | | |
780 | 780 | | |
781 | 781 | | |
782 | | - | |
| 782 | + | |
783 | 783 | | |
784 | 784 | | |
785 | 785 | | |
| |||
814 | 814 | | |
815 | 815 | | |
816 | 816 | | |
817 | | - | |
| 817 | + | |
818 | 818 | | |
819 | 819 | | |
820 | 820 | | |
| |||
957 | 957 | | |
958 | 958 | | |
959 | 959 | | |
960 | | - | |
| 960 | + | |
961 | 961 | | |
962 | 962 | | |
963 | 963 | | |
| |||
1159 | 1159 | | |
1160 | 1160 | | |
1161 | 1161 | | |
1162 | | - | |
| 1162 | + | |
1163 | 1163 | | |
1164 | 1164 | | |
1165 | 1165 | | |
| |||
2543 | 2543 | | |
2544 | 2544 | | |
2545 | 2545 | | |
2546 | | - | |
| 2546 | + | |
2547 | 2547 | | |
2548 | 2548 | | |
2549 | 2549 | | |
| |||
2792 | 2792 | | |
2793 | 2793 | | |
2794 | 2794 | | |
2795 | | - | |
| 2795 | + | |
2796 | 2796 | | |
2797 | 2797 | | |
2798 | 2798 | | |
| |||
2909 | 2909 | | |
2910 | 2910 | | |
2911 | 2911 | | |
2912 | | - | |
| 2912 | + | |
2913 | 2913 | | |
2914 | 2914 | | |
2915 | 2915 | | |
| |||
3890 | 3890 | | |
3891 | 3891 | | |
3892 | 3892 | | |
3893 | | - | |
| 3893 | + | |
3894 | 3894 | | |
3895 | 3895 | | |
3896 | 3896 | | |
| |||
4069 | 4069 | | |
4070 | 4070 | | |
4071 | 4071 | | |
4072 | | - | |
| 4072 | + | |
4073 | 4073 | | |
4074 | 4074 | | |
4075 | 4075 | | |
| |||
4317 | 4317 | | |
4318 | 4318 | | |
4319 | 4319 | | |
4320 | | - | |
| 4320 | + | |
4321 | 4321 | | |
4322 | 4322 | | |
4323 | 4323 | | |
| |||
4516 | 4516 | | |
4517 | 4517 | | |
4518 | 4518 | | |
4519 | | - | |
| 4519 | + | |
4520 | 4520 | | |
4521 | 4521 | | |
4522 | 4522 | | |
| |||
4550 | 4550 | | |
4551 | 4551 | | |
4552 | 4552 | | |
4553 | | - | |
| 4553 | + | |
4554 | 4554 | | |
4555 | 4555 | | |
4556 | 4556 | | |
| |||
4633 | 4633 | | |
4634 | 4634 | | |
4635 | 4635 | | |
4636 | | - | |
| 4636 | + | |
4637 | 4637 | | |
4638 | 4638 | | |
4639 | 4639 | | |
| |||
5629 | 5629 | | |
5630 | 5630 | | |
5631 | 5631 | | |
5632 | | - | |
| 5632 | + | |
5633 | 5633 | | |
5634 | 5634 | | |
5635 | 5635 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
224 | 224 | | |
225 | 225 | | |
226 | 226 | | |
227 | | - | |
| 227 | + | |
228 | 228 | | |
229 | 229 | | |
230 | 230 | | |
| |||
413 | 413 | | |
414 | 414 | | |
415 | 415 | | |
416 | | - | |
| 416 | + | |
417 | 417 | | |
418 | 418 | | |
419 | 419 | | |
420 | 420 | | |
421 | 421 | | |
422 | | - | |
423 | | - | |
424 | | - | |
425 | | - | |
426 | | - | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
427 | 427 | | |
428 | 428 | | |
429 | 429 | | |
| |||
0 commit comments