docs: fix stale project-structure paths in README and CONTRIBUTING#1169
Merged
tcoratger merged 1 commit intoJun 26, 2026
Merged
Conversation
The documented project structure referenced directories that no longer
exist (src/lean_spec/subspecs/, poseidon1/, tests/lean_spec/subspecs/,
tests/consensus/devnet/). Align README and CONTRIBUTING with the actual
src/lean_spec/{spec,node,cli}/ layout: Poseidon now lives at
spec/crypto/poseidon.py, and fork specs are tested via consensus vectors
under tests/consensus/lstar/. Docs only; no code changes.
aryaethn
force-pushed
the
docs/fix-project-structure-paths
branch
from
f569c50 to
46c9fda
Compare
tcoratger
approved these changes
Jun 26, 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
2 participants
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
The documented project structure references directories that no longer exist:
src/lean_spec/subspecs/and theposeidon1/subspec — Poseidon now lives atsrc/lean_spec/spec/crypto/poseidon.pytests/lean_spec/subspecs/— unit tests now live undertests/spec/andtests/node/tests/consensus/devnet/{fc,state_transition}— consensus vectors now live undertests/consensus/lstar/{fork_choice,state_transition,...}This aligns the README "Project Structure" tree and CONTRIBUTING's "Adding New Subspecifications" section with the actual
src/lean_spec/{spec,node,cli}/layout, mirroring the current crypto subspecs (spec/crypto/, with thexmsspackage as the example). It also reconciles the tree's mixed|/│characters.Docs only — no code changes.
Tested