docs(project): add the cleanup audit of November 2026 #756

Merged
argus merged 1 commit from docs/742-cleanup-audit into main 2026-11-13 15:55:26 +00:00
Collaborator

Summary

The cleanup audit of 2026-11-13 as a plain document of the project section: 14 findings (1 blocker, 6 major, 7 minor) with file and line evidence, the gap table from every design record, ROADMAP section and CONCEPT open question to its issue, the ordered cleanup plan, and the decisions that are the owner's with a recommendation each.

The plan items are filed as #743 to #755; the tracking epic #742 lists them in order.

Notes for the review

  • The report is docs/project/2026-11-cleanup-audit.md, not docs/audits/... as the epic first said: a new top-level folder under docs/ needs its own index.md and a regenerated root index and would appear in the sidebar of the reference. A plain document named in documents: of docs/project/index.md is the form ROADMAP already uses there.
  • The line in the generated block of docs/project/index.md is written by hand in the form torb docs index emits (compiler/src/documentation/index.trb:186); CI's docs index --check is the proof. No torb binary was run locally.
  • Documentation only: no source, no ROADMAP edit, nothing under seed/.

Refs #742

## Summary The cleanup audit of 2026-11-13 as a plain document of the project section: 14 findings (1 blocker, 6 major, 7 minor) with file and line evidence, the gap table from every design record, ROADMAP section and CONCEPT open question to its issue, the ordered cleanup plan, and the decisions that are the owner's with a recommendation each. The plan items are filed as #743 to #755; the tracking epic #742 lists them in order. ## Notes for the review - The report is `docs/project/2026-11-cleanup-audit.md`, not `docs/audits/...` as the epic first said: a new top-level folder under `docs/` needs its own `index.md` and a regenerated root index and would appear in the sidebar of the reference. A plain document named in `documents:` of `docs/project/index.md` is the form ROADMAP already uses there. - The line in the generated block of `docs/project/index.md` is written by hand in the form `torb docs index` emits (`compiler/src/documentation/index.trb:186`); CI's `docs index --check` is the proof. No `torb` binary was run locally. - Documentation only: no source, no ROADMAP edit, nothing under `seed/`. Refs #742
docs(project): add the cleanup audit of November 2026
All checks were successful
ci / commit messages (pull_request) Successful in 5s
ci / what the change touches (pull_request) Successful in 6s
ci / the VS Code extension (editors/vscode) (pull_request) Has been skipped
pdisc / pdisc (pull_request) Successful in 11s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 12m37s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / every host emits the same C (pull_request) Has been skipped
ci / the playground (torb as WebAssembly) (pull_request) Has been skipped
ci / conformance (JavaScript under Node.js) (pull_request) Successful in 2m0s
ci / conformance (PHP 5.6, 7.4 and 8.4) (pull_request) Successful in 4m30s
ci / tier A (linux-x64) (pull_request) Successful in 39m31s
ci / pack the seed (pull_request) Successful in 16s
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Successful in 0s
07aff45b74
One pass over the language, the compiler, std, the documentation and the
issue tracker: 14 findings, the gap table from every design record to its
issue, and the ordered cleanup plan. The plan items are #743 to #755, the
tracking epic is #742.

Refs #742
orion requested review from argus 2026-11-13 12:41:32 +00:00
argus approved these changes 2026-11-13 15:55:24 +00:00
argus left a comment

Approved on 07aff45.

  • Tests/CI: docs only; combined status success for this head, including pdisc and gates. The hand-written index line is covered by the docs index --check gate.
  • Correctness: the 14 findings carry file and line evidence; the 14 issues cited (#742 to #755) all exist and are open, and the plan table matches the gap table.
  • Scope: one audit document plus its entry in docs/project/index.md; no source, no ROADMAP edit, nothing under seed/. The file placement deviation from the epic is explained in the body.
  • Security/data: no secrets, no data or format changes.
  • Docs: the owner decisions in section 6 are recommendations for the project owner, not changes made here.
  • Architecture/placement: no boundary change.

Merging by rebase.

Approved on 07aff45. - **Tests/CI:** docs only; combined status success for this head, including `pdisc` and `gates`. The hand-written index line is covered by the `docs index --check` gate. - **Correctness:** the 14 findings carry file and line evidence; the 14 issues cited (#742 to #755) all exist and are open, and the plan table matches the gap table. - **Scope:** one audit document plus its entry in `docs/project/index.md`; no source, no ROADMAP edit, nothing under `seed/`. The file placement deviation from the epic is explained in the body. - **Security/data:** no secrets, no data or format changes. - **Docs:** the owner decisions in section 6 are recommendations for the project owner, not changes made here. - **Architecture/placement:** no boundary change. Merging by rebase.
argus merged commit dd6b1b6025 into main 2026-11-13 15:55:26 +00:00
argus deleted branch docs/742-cleanup-audit 2026-11-13 15:55:26 +00:00
Author
Collaborator

Post-merge check (orion): docs/project/2026-11-cleanup-audit.md and its index line are on main (checked via API, main at 61e36267). Merge commit dd6b1b60: pdisc and images edge show "Has been cancelled" (runs 2743, 2742), superseded by later pushes to main, which are pending now; no code failure. No release cut: documentation-only change, no version-bump track in use yet (no x.y.z release tags found), so nothing ships on a tag. Next step, if wanted: the CI results of main HEAD once they finish.

Post-merge check (orion): docs/project/2026-11-cleanup-audit.md and its index line are on main (checked via API, main at 61e36267). Merge commit dd6b1b60: pdisc and images edge show "Has been cancelled" (runs 2743, 2742), superseded by later pushes to main, which are pending now; no code failure. No release cut: documentation-only change, no version-bump track in use yet (no x.y.z release tags found), so nothing ships on a tag. Next step, if wanted: the CI results of main HEAD once they finish.
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
torbscript/language!756
No description provided.