Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorg specs by fork and move ssz out to own folder #1564

Merged
merged 2 commits into from
Jan 10, 2020
Merged

Conversation

djrtwo
Copy link
Contributor

@djrtwo djrtwo commented Jan 10, 2020

Modified core specs, ssz specs, and test specs/generators into a more manageable form. Notably:

  • specs/ now has sub-directories grouped by fork (phase)
  • SSZ is moved out to its own folder in anticipation of being released as its own spec
  • test format specs and generators are grouped under tests/ and what used to be test_libs is moved into tests/core.

Made sure the build, tests, and generators run. Attempted to go through and fix all relative links within the repo. Very well could have missed something 😬

Yes, this is going to break external links to branch-based files. Links to files within releases will be fine. Discussed leaving a bunch of old files with redirects in them, but opted for this for cleanliness.

New Structure:

specs/
β”œβ”€β”€ phase0/
β”‚   β”œβ”€β”€ beacon-chain.md
β”‚   β”œβ”€β”€ deposit-contract.md
β”‚   β”œβ”€β”€ fork-choice.md
β”‚   β”œβ”€β”€ p2p-interface.md
β”œβ”€β”€ phase1/
β”‚   β”œβ”€β”€ beacon-chain.md
β”‚   β”œβ”€β”€ custody-game.md
β”‚   └── shard-data-chains.md
β”‚   └── light-client-sync.md
ssz/
β”œβ”€β”€ simple-serialize.md
β”œβ”€β”€ merkle-proofs.md
tests/
β”‚   β”œβ”€β”€ core/
β”‚   β”œβ”€β”€ formats/
β”‚   └── generators/

Copy link
Collaborator

@protolambda protolambda left a comment

Choose a reason for hiding this comment

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

fork-dir-reorg really says it all. But things do look a lot better now, and better for phase1+ documents organization.

And /ssz can soon move out to some repo like ethereum/eth2.0-ssz (name TBD). For reference, the current more complete ssz spec draft is here: https://github.com/protolambda/eth2.0-ssz/ This draft will be updated with additional information to cover/reference partials, caching and merkle stores.

@djrtwo djrtwo merged commit 1a450c5 into dev Jan 10, 2020
@djrtwo djrtwo deleted the fork-dir-reorg branch January 10, 2020 22:05
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.

None yet

2 participants