Repository navigation
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
Open
devin-ai-integration[bot] wants to merge 2 commits into
devin-ai-integration[bot] wants to merge 2 commits into
Conversation
…s the tree has Co-Authored-By: jason.han <hanhuijun@gmail.com>
Contributor
Author
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Contributor
Author
There was a problem hiding this comment.
🔍 Devin Review: 2 flags
Not posted on this PR by your GitHub settings — view them in Devin Review. (Configure)
…ree has in the architecture module map Co-Authored-By: jason.han <hanhuijun@gmail.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
Third area of the documentation accuracy audit (after #1503
examples/and #1504 user docs):docs/internals/architecture.mdand the other present-tense implementation pages underdocs/internals, anddocs/project/*.mdoutsidearchive/, measured atdevelop76c98694c(merge of #1483). Every repository path, Go test name,go test … -runcommand,maketarget, 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.mdis out of scope and untouched; what it names stale is listed below. Docs-only.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/identityinternal/check/passes/…,internal/workspace/model/…,internal/semantic/{symbols,resolve,semantics},internal/workspace/libs,internal/syntax/parser/…,internal/exec/solve/doc.go, andtests/identityforTestPilotLibraryXMI(git ls-files;test -eon each path)pilot-rejection.md:449,adjudications.md:58import_visibility.goimport-visibilitycode and pass live ininternal/check/passes/grammar_violation.go; noimport_visibility.goexists (grep -rl import-visibility internal/check/passes)omg-issues.md:1521,spec-pilot-gap-register.md:409,pilot-differential.md:3403internal/check/passes/control_node.gointernal/check/passes/behavior/control_node.godiagram-layout-annotations.md:342internal/check/passes/diagram_layout.gointernal/check/passes/diagram/layout.go(DiagramLayoutPassis declared there)bitwise-complement.md:109cmd/pilot-exec-difftools/cmd/pilot-exec-diffspec-compliance.md:3226, 3251scripts/pin_release_checksums.py,internal/frontend/grpc/attributes.goclient/python/scripts/pin_release_checksums.py,internal/frontend/symbolfacts/attributes.gospec-compliance.md:37, 75Calculations (14/14 features),Actions (19/19 features)14/14was written inc5fd887d2; Actions had 20 ateaa526fe7and has 21 now)performance-release-0.10.1-vs-0.10.0.md:474,performance-release-0.11.0-vs-0.10.1.md:513scripts/download-apollo11.shgit log --all -- scripts/download-apollo11.shis empty); the corpus isairbus/apollo-11-sysml-v2at6e9c93f, asdocs/internals/performance.mdclones itdocs/internals/architecture.md:20, 55-59, 110-11898 of 98 standard library files … 4 OpenSysML extensions;cmd/with 3 binaries;internal/frontend/with 6 packages;client/python,client/rustonly; noeditors/; no prose parsers110/110(now linked to the roadmap's gate table, per CONTRIBUTING's one-home rule);ls cmd/has 9 binaries (MakefileCOMMANDS/WASM_COMMANDS),ls internal/frontend/16 packages,ls client/8 directories,editors/{vscode,jupyterlab,mdk,syson},internal/ir/docplan/markupparses Markdown/AsciiDoc bodiesChecked and accurate (no edit):
docs/internals/architecture.md— every package directory,Test*name,pkg.Identifierandgo test … -runcommand it names exists; everygo test … -runcommand indocs/internalsanddocs/projectnames an existing test in an existing package; everymaketarget named outsideroadmap.mdis in theMakefile; every workflow file, job and release asset name inreleasing.mdandnightly.mdis in.github/workflows/.circleci/config.yml;training-examples.md100/100matchestests/corpus/testdata/training_examples_expected.txt(# files: 100, no failing rows); the Constraints7/7and Requirements9/9lists.Left as written (evidence for a follow-up):
docs/project/lossless-library-records.md:52namesinternal/workspace/libs/index_only_test.goas the proof that no library symbol carries aDecl; no file of that name ever existed in the history and no test ininternal/workspace/libsasserts 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 ofdocs/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) anddocs/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 undertools/cmd/),internal/workspace/model/testdata/training_examples_expected.txtandinternal/translate/export/testdata/corpus_roundtrip_expected.txt(nowtests/corpus/testdata/),internal/{hygiene,perfbench,baseline,fixtures,junit,doccounts,stressmodel,fuml,pssm,testutil,errata,xmi,core}(moved totests/,tools/or renamed),cmd/ontology-modules,internal/translate/rdf/ontology/modules,scripts/download-ontology-sources.shandmake ontology-modules-check(none exist).docs/project/README.mddoes 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.docs/internals/designanddocs/internals/notesname 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 —⚠️ claims of ⚠️ , 2 ❌ rows) against their tests, and the committed baseline JSON files beyond confirming the pages'
docs/internals/architecture.md,docs/project/README.md,pilot-corpora.md,training-examples.md, thespec-compliance.mdfeature lists and the edited lines of each page above; checked by name/figure sweep and skimmed — the remainingdocs/internals/*.mdanddocs/project/*.md,releasing.mdandnightly.md(procedure read against the workflows for names only, not re-executed); not reached — the per-row ✅/spec-compliance.md(1018 ✅, 127-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 onspec-compliance.md). None of them renames these paths.developmoved to111a59a2aafter this branch was cut; it dry-merges clean too and was not merged in.How it was verified
At
badd712b9and again at the architecture.md follow-up commit (this head, ondevelop76c98694c):python3 scripts/check-doc-links.py—0 broken link(s), rc 0python3 scripts/check-doc-ids.py— rc 0python3 scripts/check-doc-figures.py— rc 0make docs-landing-assetsthenmake docs-check— rc 0python -m mkdocs build --strict— rc 0python3 scripts/changelog.py check— rc 0Checklist
make testandmake lintpass locally — docs-only change; the documentation gates above are the ones that cover itchanges/unreleased/docs-audit-internals-project.fixed.mdmake docs-countsrun if a gate count moved — no gate count moved