specs
specs copied to clipboard
Specs Layout Refactor
Right now it is difficult to contribute or consume the specs because of the way that they are laid out. It is not clear where to add new information and there isn't an easy way to know what functionality is associated with what network upgrade.
We should lay out the specs in a way where there is a set of topics and directories for each network upgrade. If a topic is changed as part of a network upgrade, we should include a markdown file named after the topic inside which includes the functionality specific for that network upgrade.
A simplified example below:
├── bedrock
│ ├── batcher.md
│ ├── derivation-pipeline.md
│ ├── predeploys.md
│ └── state-transition.md
├── canyon
│ └── state-transition.md
├── delta
│ └── span-batches.md
├── ecotone
│ └── predeploys.md
├── fjord
└── regolith
└── state-transition.md