This repository contains the specs for the InterPlanetary Network Indexer (IPNI) Protocol and its associated subsystems.
Suggestions, contributions, criticisms are welcome. To contribute, simply open a PR on this repo with suggested changes to existing specification, or introduce a new one.
New specification proposals should:
Proposed changes to existing specifications should:
- clearly document the motivation for change
- ideally avoid breaking changes.
- when breaking changes are unavoidable, the proposal should outline affected systems, risk and mitigation.
Specifications use the following labels to identify their state:
- A work-in-progress, possibly to describe an idea before actually committing to a full draft.
- A draft that is ready to review, with sufficient detail to be implementable.
- The spec has been adopted, implemented and can be used as a reference point to learn how the system works.
- The spec is finalised. It may alter in the future but the system it specifies will not change fundamentally.
- The spec will not change.
- The spec is no longer in use and should not be extended nor built upon.
This repository follows the IPFS Community Code of Conduct.