fix: docs accuracy — broken paths, missing fields, wrong counts#280
Merged
fix: docs accuracy — broken paths, missing fields, wrong counts#280
Conversation
- Fix linking-libraries.mdx: all examples used non-existent `libs/` directory; changed to `examples/external-libs/` which is the actual convention used by the CryptoHash example - Fix core.mdx: ContractState was shown with 7 fields but actual Core.lean has 11 — added storageMapUint, storageMap2, knownAddresses, and events with descriptions - Fix verification.mdx: Stdlib count was 64 but manifest has 69; added MappingAutomation.lean (7 theorems, 2 shared with Automation) - Fix add-contract.mdx: scaffold count said 6 but creates 7 (missing Proofs.lean re-export shim); proof path pointed to re-export shim instead of actual proof files in Verity/Proofs/ Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced Feb 17, 2026
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.
Summary
linking-libraries.mdx: all examples used non-existentlibs/directory — a developer following the Quick Start would fail at step 1core.mdx: ContractState shown with 7 fields but actual has 11 — missingstorageMapUint,storageMap2,knownAddresses,eventsverification.mdx: Stdlib count was 64 but manifest has 69 —MappingAutomation.lean(7 theorems) was added but never reflected in docsadd-contract.mdx: scaffold count said "6 files" but creates 7; proof path pointed to re-export shim instead of actual proof directoryDetails
linking-libraries.mdx (highest impact)
Every command in the TL;DR, Quick Start, Debugging, and CLI Reference sections used paths like
libs/MyHash.yulorlibs/Poseidon.yul. This directory does not exist in the repo. The actual convention isexamples/external-libs/(where PoseidonT3.yul and PoseidonT4.yul live). Changed all occurrences to use the real path, including addingmkdir -p examples/external-libsin the TL;DR.core.mdx
The ContractState struct was shown with 7 fields but the actual
Core.lean(lines 37-48) has 11 fields. The 4 missing fields are critical for understanding the EDSL:storageMapUint— uint256-keyed mappingsstorageMap2— double mappings (e.g.,allowances[owner][spender])knownAddresses— tracked address sets for conservation proofsevents— append-only event logverification.mdx
The Stdlib section said "64 theorems (Math 25, Automation 39)" but the manifest has 69 Stdlib entries. The 5 additional theorems come from
MappingAutomation.leanwhich was added after the docs were written. Updated to "69 theorems (Math 25, Automation 39, MappingAutomation 7; 2 shared)".add-contract.mdx
Verity/Specs/<Name>/Proofs.leanre-export shim was omitted from the count)Verity/Specs/<Name>/Proofs.lean" — that file is a re-export shim, not where you write proofs. Fixed to point toVerity/Proofs/<Name>/Basic.leanandCorrectness.leanTest plan
check_doc_counts.pypasses locally🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes correcting file counts, paths, and type/state descriptions; low risk aside from potentially breaking reader workflows if any path was still wrong.
Overview
Fixes several docs inconsistencies so tutorials match the repo:
Updates
add-contract.mdxto reflect 7 generated scaffold files and clarifies thatVerity/Specs/<Name>/Proofs.leanis a re-export shim, with proofs written underVerity/Proofs/<Name>/.Corrects
core.mdx’sContractStatedefinition to include the missing storage mapping variants plusknownAddressesandevents, and updates the surrounding explanation accordingly. The linking guide switches all examples from the non-existentlibs/directory toexamples/external-libs/(including addingmkdir -p), andverification.mdxupdates the Stdlib theorem count to includeMappingAutomation.Written by Cursor Bugbot for commit ed7dcb6. This will update automatically on new commits. Configure here.