Skip to content

docs(project): point the project records at the code paths and figures the tree has - #1505

Open
devin-ai-integration[bot] wants to merge 2 commits into
developfrom
docs/audit-internals-project
Open

devin-ai-integration[bot] wants to merge 2 commits into
developfrom
docs/audit-internals-project

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

What and why

Third area of the documentation accuracy audit (after #1503 examples/ and #1504 user docs): docs/internals/architecture.md and the other present-tense implementation pages under docs/internals, and docs/project/*.md outside archive/, measured at develop 76c98694c (merge of #1483). Every repository path, Go test name, go test … -run command, make target, workflow file, job and asset name a page names was checked against the tree, and every "N/N" figure against what it counts. docs/project/roadmap.md is out of scope and untouched; what it names stale is listed below. Docs-only.

page claimed actual (proving command)
docs/project/pilot-differential.md, pilot-rejection.md, pilot-xpect.md, pilot-corpora.md (27 references) internal/core/passes/…, internal/core/model/…, internal/core/symbols, internal/core/resolve, internal/core/libs, internal/core/parser/…, internal/core/semantics/implicit.go, internal/core/solve/doc.go, internal/core/identity the layered packages those files live in today: internal/check/passes/…, internal/workspace/model/…, internal/semantic/{symbols,resolve,semantics}, internal/workspace/libs, internal/syntax/parser/…, internal/exec/solve/doc.go, and tests/identity for TestPilotLibraryXMI (git ls-files; test -e on each path)
pilot-rejection.md:449, adjudications.md:58 import_visibility.go the import-visibility code and pass live in internal/check/passes/grammar_violation.go; no import_visibility.go exists (grep -rl import-visibility internal/check/passes)
omg-issues.md:1521, spec-pilot-gap-register.md:409, pilot-differential.md:3403 internal/check/passes/control_node.go internal/check/passes/behavior/control_node.go
diagram-layout-annotations.md:342 internal/check/passes/diagram_layout.go internal/check/passes/diagram/layout.go (DiagramLayoutPass is declared there)
bitwise-complement.md:109 cmd/pilot-exec-diff tools/cmd/pilot-exec-diff
spec-compliance.md:3226, 3251 scripts/pin_release_checksums.py, internal/frontend/grpc/attributes.go client/python/scripts/pin_release_checksums.py, internal/frontend/symbolfacts/attributes.go
spec-compliance.md:37, 75 Calculations (14/14 features), Actions (19/19 features) 16 and 21 bullets follow (the Calculations list already had 16 when 14/14 was written in c5fd887d2; Actions had 20 at eaa526fe7 and has 21 now)
performance-release-0.10.1-vs-0.10.0.md:474, performance-release-0.11.0-vs-0.10.1.md:513 Apollo 11 fetched by scripts/download-apollo11.sh no such script ever existed (git log --all -- scripts/download-apollo11.sh is empty); the corpus is airbus/apollo-11-sysml-v2 at 6e9c93f, as docs/internals/performance.md clones it
docs/internals/architecture.md:20, 55-59, 110-118 98 of 98 standard library files … 4 OpenSysML extensions; cmd/ with 3 binaries; internal/frontend/ with 6 packages; client/python, client/rust only; no editors/; no prose parsers the gate is 110/110 (now linked to the roadmap's gate table, per CONTRIBUTING's one-home rule); ls cmd/ has 9 binaries (Makefile COMMANDS/WASM_COMMANDS), ls internal/frontend/ 16 packages, ls client/ 8 directories, editors/{vscode,jupyterlab,mdk,syson}, internal/ir/docplan/markup parses Markdown/AsciiDoc bodies

Checked and accurate (no edit): docs/internals/architecture.md — every package directory, Test* name, pkg.Identifier and go test … -run command it names exists; every go test … -run command in docs/internals and docs/project names an existing test in an existing package; every make target named outside roadmap.md is in the Makefile; every workflow file, job and release asset name in releasing.md and nightly.md is in .github/workflows / .circleci/config.yml; training-examples.md 100/100 matches tests/corpus/testdata/training_examples_expected.txt (# files: 100, no failing rows); the Constraints 7/7 and Requirements 9/9 lists.

Left as written (evidence for a follow-up):

  • docs/project/lossless-library-records.md:52 names internal/workspace/libs/index_only_test.go as the proof that no library symbol carries a Decl; no file of that name ever existed in the history and no test in internal/workspace/libs asserts that property (the nearest, TestLibraryBodiesArePresentOnEveryPath, asserts the opposite direction). Needs the record's author to name the real proof.
  • docs/project/element-identity-annotations.md:35 ("the roadmap records the open risk that another conforming client rejects a non-UUID id") and the open rows of docs/project/lossless-library-records.md §7 (L3-1 … L3-3) are design-record rationale written before the work they motivate; roadmap D12 (done) gives library elements their normative UUIDs and L3 landed library-feature materialization (fix(lower): perform inherited action steps and inherit step multiplicity #830), but neither closes those sentences verbatim (user elements still derive ids from names; the record format is a separate stage), so they are left as history rather than restated as status.
  • docs/project/pilot-differential.md:47 (tools/referee/diff/order.go, orderByImports) and docs/project/html-document-backend.md:16-18 (internal/doc/docpdf/*.go) describe superseded code in the past tense; left as history.
  • docs/project/roadmap.md (out of scope): 35 stale paths — cmd/pilot-exec-diff, cmd/fuml-referee, cmd/pssm-referee, cmd/stress-model, cmd/doc-counts, cmd/validation-census, cmd/pilot-diff (now under tools/cmd/), internal/workspace/model/testdata/training_examples_expected.txt and internal/translate/export/testdata/corpus_roundtrip_expected.txt (now tests/corpus/testdata/), internal/{hygiene,perfbench,baseline,fixtures,junit,doccounts,stressmodel,fuml,pssm,testutil,errata,xmi,core} (moved to tests/, tools/ or renamed), cmd/ontology-modules, internal/translate/rdf/ontology/modules, scripts/download-ontology-sources.sh and make ontology-modules-check (none exist).
  • docs/project/README.md does not list ten project pages (diagram-layout-annotations, element-identity-annotations, extension-libraries, large-model-scaling-design, mdk-parity, native-compilation, pilot-rejection, satellite-network-stress-test, spec-examples, third-party-notices); the index does not claim to be complete, so nothing was added.
  • Design records under docs/internals/design and docs/internals/notes name paths that have since moved (internal/pssm/classify.go, cmd/pssm-referee, .github/workflows/build.yml, docs/PYTHON_API.md, …); they were read for present-tense claims only and none was found that the tree contradicts.

Coverage: fully read — docs/internals/architecture.md, docs/project/README.md, pilot-corpora.md, training-examples.md, the spec-compliance.md feature lists and the edited lines of each page above; checked by name/figure sweep and skimmed — the remaining docs/internals/*.md and docs/project/*.md, releasing.md and nightly.md (procedure read against the workflows for names only, not re-executed); not reached — the per-row ✅/⚠️ claims of spec-compliance.md (1018 ✅, 127 ⚠️, 2 ❌ rows) against their tests, and the committed baseline JSON files beyond confirming the pages' -update-* commands name existing tests.

Overlap (open PRs touching these files, each dry-merged onto this head with no conflict): #1502 (304df41bb, pilot-differential.md), #1492 (8a44a9aa2, spec-compliance.md), #1484 (70dae7174, adjudications.md, pilot-*.md, spec-compliance.md, spec-pilot-gap-register.md), #1471 (6951774ae, spec-compliance.md), #1466 (e589bddc2, pilot-rejection.md, spec-compliance.md), #1507 (b6978b3a1), #1508 (83c8db3c5), #1509 (39b79e92e) (the last three on spec-compliance.md). None of them renames these paths. develop moved to 111a59a2a after this branch was cut; it dry-merges clean too and was not merged in.

How it was verified

At badd712b9 and again at the architecture.md follow-up commit (this head, on develop 76c98694c):

  • python3 scripts/check-doc-links.py — 0 broken link(s), rc 0
  • python3 scripts/check-doc-ids.py — rc 0
  • python3 scripts/check-doc-figures.py — rc 0
  • make docs-landing-assets then make docs-check — rc 0
  • python -m mkdocs build --strict — rc 0
  • python3 scripts/changelog.py check — rc 0

Checklist

  • make test and make lint pass locally — docs-only change; the documentation gates above are the ones that cover it
  • Tests added or updated for the change — not applicable, no code changed
  • Documentation extended where it already covers the surface (see CONTRIBUTING.md)
  • Changelog entry added as changes/unreleased/docs-audit-internals-project.fixed.md
  • baselines regenerated and make docs-counts run if a gate count moved — no gate count moved
  • No internal work-item labels in the body, docs, or changelog

…s the tree has

Co-Authored-By: jason.han <hanhuijun@gmail.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@devin-ai-integration
devin-ai-integration Bot marked this pull request as ready for review October 25, 2026 08:13

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔍 Devin Review: 2 flags

Not posted on this PR by your GitHub settings — view them in Devin Review. (Configure)

Devin Review

…ree has in the architecture module map

Co-Authored-By: jason.han <hanhuijun@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant