See https://www.notion.so/Waku-Improvement-Proposals-6a7fd633d41f44689ea274359b60f0f0 for prior conversation on this topic.
TL;DR
- move (only) Waku specs to waku.org/specs
- remove the confusing
raw
status for specs
- no form requirement at all for new specs
- only mature, proven specs will be handed in to Vac as RFCs ready to be stabilised
- the most important core specs (relay, filter, store,…) will maintain their existing numbers and be iterated towards
stable
with the help of Vac
- more descriptive names for specs
- much better indexing on all our sites to help newcomers find what's important
- better defined community collaboration process
Goals:
- Waku protocols and specifications should reside within the Waku organization for consistency and coherence
- Find a balance between high-quality specifications and removing formalities to allow effortless contribution to new and existing specifications
- A spec repository structure that is intuitive and easy to navigate
- Good tagging and indexing mechanisms to reduce reliance on directory structure for navigation
- It should be easy for newcomers to the protocol to find important/key specs
- A well-defined process for community members to suggest their own extensions of the Waku protocol or participate in the spec review process
Based on the above, this doc contains a proposal as starting point.
Repo structure
This recommendation takes inspiration from https://eips.ethereum.org/