Skip to content

docs: recover the as-built computational model #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
downwithbgp merged 8 commits into from
Aug 4, 2026
Merged

docs: recover the as-built computational model #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ea194bf
docs: recover core data structures and invariant register (session 56…
downwithbgp Aug 4, 2026
3009593
docs: recover algorithm catalog, state machines, and algorithm-data m…
downwithbgp Aug 4, 2026
44a801f
docs: synthesize the as-built computational model (session 56 design …
downwithbgp Aug 4, 2026
14fbbbf
docs: add dated Wirthian design-recovery audit and navigation links (…
downwithbgp Aug 4, 2026
631b7d8
docs: register session 56 design-recovery documents in the repository…
downwithbgp Aug 4, 2026
5cd106e
docs: register session 56 design-recovery files in the documentation …
downwithbgp Aug 4, 2026
087ea23
docs: fix review findings — readiness state count, run_transitions id…
downwithbgp Aug 4, 2026
00899a4
docs: correct module-doc line reference in discrepancy table
downwithbgp Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ follow-up ADRs.
| Analysis artifact reference | `docs/reference/ARTIFACTS.md` |
| Schema/version matrix | `docs/reference/SCHEMA-VERSIONS.md` |
| Performance measurements | `docs/BENCHMARK.md` |
| As-built computational model (program equation, inputs, effects) | `docs/computational-model.md` |
| Design recovery: data structures, algorithms, invariants, state machines, matrix | `docs/design/` |
| Data sources: GRNOC, RouteViews, RIPE RIS | `docs/sources/` |
| Terminology (normative definitions) | `docs/GLOSSARY.md` |
| Case studies | `case-studies/` (per-case README files) |
Expand Down
18 changes: 16 additions & 2 deletions docs/audits/2026-08-documentation-inventory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ The following lists are compared with `git ls-files` by
must be classified in a table above (or in `repository-inventory.json`
for non-documentation files).

### Tracked Markdown files (89, excluding `spec/`)
### Tracked Markdown files (96, excluding `spec/`)

```
.github/PULL_REQUEST_TEMPLATE.md
Expand Down Expand Up @@ -244,9 +244,15 @@ docs/ADRs/MONOCLE-DATAPLANE.md
docs/ADRs/README.md
docs/ADRs/RIPE-RIS-SUPPORT.md
docs/BENCHMARK.md
docs/computational-model.md
docs/DATA_PROVENANCE.md
docs/DECISIONS.md
docs/DESIGN.md
docs/design/algorithms.md
docs/design/algorithm-data-matrix.md
docs/design/data-structures.md
docs/design/invariants.md
docs/design/state-machines.md
docs/DOMAIN.md
docs/GLOSSARY.md
docs/MONOCLE_EVALUATION.md
Expand Down Expand Up @@ -279,6 +285,7 @@ docs/audits/2026-08-repository-truth-audit.md
docs/audits/2026-08-second-network-neutrality.md
docs/audits/2026-08-smithville-source-refresh.md
docs/audits/2026-08-specification-coverage.md
docs/audits/2026-08-wirthian-design-recovery.md
docs/audits/README.md
docs/audits/external-links-2026-08.md
docs/evaluation/ALPHA-FREEZE.md
Expand Down Expand Up @@ -315,7 +322,7 @@ tests/fixtures/README.md



### Tracked files under `docs/` (69)
### Tracked files under `docs/` (76)

```
docs/ADRs/CASE-STUDY-LAYER.md
Expand All @@ -325,9 +332,15 @@ docs/ADRs/MONOCLE-DATAPLANE.md
docs/ADRs/README.md
docs/ADRs/RIPE-RIS-SUPPORT.md
docs/BENCHMARK.md
docs/computational-model.md
docs/DATA_PROVENANCE.md
docs/DECISIONS.md
docs/DESIGN.md
docs/design/algorithms.md
docs/design/algorithm-data-matrix.md
docs/design/data-structures.md
docs/design/invariants.md
docs/design/state-machines.md
docs/DOMAIN.md
docs/GLOSSARY.md
docs/MONOCLE_EVALUATION.md
Expand Down Expand Up @@ -360,6 +373,7 @@ docs/audits/2026-08-repository-truth-audit.md
docs/audits/2026-08-second-network-neutrality.md
docs/audits/2026-08-smithville-source-refresh.md
docs/audits/2026-08-specification-coverage.md
docs/audits/2026-08-wirthian-design-recovery.md
docs/audits/README.md
docs/audits/external-links-2026-08.md
docs/audits/repository-inventory.json
Expand Down
13 changes: 10 additions & 3 deletions docs/audits/2026-08-repository-truth-audit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ This audit verifies that every tracked file is classified, that every current st

## Summary

Tracked files: **463** · inventory entries: **463**
Tracked files: **470** · inventory entries: **470**

| Category | Files |
|---|---|
| Immutable or generated evidence | 148 |
| Production source | 106 |
| Normative current documentation | 42 |
| Historical decision record | 41 |
| Normative current documentation | 48 |
| Historical decision record | 42 |
| Reviewed case-study interpretation | 30 |
| Script or developer tool | 25 |
| Configuration | 24 |
Expand Down Expand Up @@ -293,9 +293,16 @@ Tracked files: **463** · inventory entries: **463**
| `docs/audits/2026-08-second-network-neutrality.md` | Historical decision record | maintainers | dated audit evidence | no | historical | status and applicability reviewed in this audit | none | reviewed in this audit |
| `docs/audits/2026-08-smithville-source-refresh.md` | Historical decision record | maintainers | dated audit evidence | no | historical | status and applicability reviewed in this audit | none | reviewed in this audit |
| `docs/audits/2026-08-specification-coverage.md` | Historical decision record | maintainers | dated audit | no | historical | status and applicability reviewed in this audit | none | reviewed in this audit |
| `docs/audits/2026-08-wirthian-design-recovery.md` | Historical decision record | maintainers | dated audit | no | historical | status and applicability reviewed in this audit | none | reviewed in this audit |
| `docs/audits/README.md` | Historical decision record | maintainers | dated audit index | no | historical | status and applicability reviewed in this audit | none | reviewed in this audit |
| `docs/audits/external-links-2026-08.md` | Normative current documentation | maintainers | dated curl checks of documented external URLs | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/audits/repository-inventory.json` | Configuration | maintainers | reviewed classification of tracked files | no | current | reviewed in this audit | none | reviewed in this audit |
| `docs/computational-model.md` | Normative current documentation | contributors and maintainers | implementation + canonical evidence (see docs/README authority map) | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/design/algorithm-data-matrix.md` | Normative current documentation | contributors and maintainers | implementation + canonical evidence (session 56 design recovery) | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/design/algorithms.md` | Normative current documentation | contributors and maintainers | implementation + canonical evidence (session 56 design recovery) | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/design/data-structures.md` | Normative current documentation | contributors and maintainers | implementation + canonical evidence (session 56 design recovery) | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/design/invariants.md` | Normative current documentation | contributors and maintainers | implementation + canonical evidence (session 56 design recovery) | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/design/state-machines.md` | Normative current documentation | contributors and maintainers | implementation + canonical evidence (session 56 design recovery) | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/evaluation/ALPHA-FREEZE.md` | Normative current documentation | contributors | reviewed protocol | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/evaluation/EVALUATION-DATA-HANDLING.md` | Normative current documentation | evaluators | reviewed protocol | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
| `docs/evaluation/EXTERNAL-PILOT-CHECKLIST.md` | Normative current documentation | facilitators | reviewed protocol | no | current | line-by-line reviewed in this audit | none | reviewed in this audit |
Expand Down
Loading
Loading