Repository navigation
Conversation
The landing page routed well and explained little: its one top-down section named no tool, artifact or lane, and almost half of it was toolchain pins and make-target semantics. Rewrite formal/README.md around a six-stage story (state, check, generate, replay, account, gate), each stage naming its directory, tool, output and the guide to read next, with a Mermaid diagram of the data flow. Add a Pipelines section with a second diagram of the three workflows (CI, Formal smoke with the differential shards, Full formal verification) and what each proves. Keep the task table, the directory table and every link target the page had, and add a Reference section so every part of the system is one hop away. Move the toolchain, Docker, Java and environment-variable prose to a new VALIDATION.md "Prerequisites" section and the trace replay commands to "Reproducing one history"; repoint the eleven references to the removed README anchors (eight guides, go/README.md and docs/maintainers.md); carry the local-clock insertion-instant note into models/README.md; refresh the source-audit and Go parity ledgers.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #237 +/- ##
=======================================
Coverage 93.73% 93.73%
=======================================
Files 78 78
Lines 11357 11357
Branches 656 656
=======================================
Hits 10645 10645
Misses 642 642
Partials 70 70
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Rendered with Mermaid 11, the data-flow diagram's subgraphs stacked bottom-to-top and the pipelines diagram put the full workflow before the pull request lanes. Draw the data flow as one left-to-right chain with the three groups as colors and a legend sentence, and draw only the full workflow's job graph, since the pull request lanes have no dependencies between their jobs and are listed in prose beneath it.
The guides used "ITF" about forty times without expanding or defining it. Add a glossary entry for the Informal Trace Format with the Apalache ADR-015 definition and the Quint CLI reference, the trace shape and integer encoding, and where the histories here live; link the term's first use in the landing page and the behavior, conformance and porting guides.
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.
Part of #220 (make
formal/readable for humans and agents).Why
formal/README.mdrouted well and explained little. Its only top-down section ("How the specification connects to code") named no tool, artifact or lane, about 900 of its 1,850 prose words were toolchain pins and make-target semantics, and its 17-row profile table duplicatedmodels/README.md. A newcomer could find the right guide but could not learn how the pieces fit without reading several of them.What changes
CI,Formal smokewith the four differential shards,Full formal verification) as a second Mermaid diagram plus one paragraph each: trigger, what runs, what it proves, how long it takes (measured: docs-only PR lanes in minutes, differential shards up to ~30 min when a Quint input changed, the scheduled full run ~2.5 h).VALIDATION.md#prerequisites; the trace-replay commands →VALIDATION.md#reproducing-one-history; the local-clock insertion-instant note → the profile's line inmodels/README.md. The 17-row profile table is replaced by inline links plus pointers tomodels/README.mdandPROFILES.md.--out-itfreference, the trace shape and bigint encoding, where the histories here live, ownerreplay/itf.mjs), linked at the term's first use in the README and the behavior, conformance and porting guides.go/README.mdanddocs/maintainers.mdpointed at the removed README sections; they now point at#run-it,VALIDATION.md#prerequisitesormodels/README.md. The link checker validates files, not anchors, so these would have gone dead silently.Measurements
The page grew by about a seventh while taking on the explanation it lacked and the reference list it was asked to keep.
Verification
make auditgreen aftercheck-source-audit.mjs --refreshon the eleven edited audited pages andcheck-go-parity.mjs --refresh-inputs.pnpm docs:checkgreen (sources, 32 formal pages' relative links).vitestformal-source-auditandformal-style: 30 passed.#anchorin the new README resolves to a heading (script-checked); repo-wide grep finds no reference to a removed anchor.Follow-up worth considering
scripts/check-docs.mjscheckFormalLinkschecks that a linked file exists but not that its#anchormatches a heading; this PR would have broken eleven anchors without it being noticed. A small extension would close that.🤖 Generated with Claude Code