Discussion: Spec Organization - Githubissues

LibertyDSNP / spec

The DSNP Spec and Website

https://spec.dsnp.org

Other

31 stars 3 forks source link

Discussion: Spec Organization #137

Closed wilwade closed 2 years ago

wilwade commented 2 years ago

The current DSNP spec mixes chain implementation and chain agnostic details.

I propose we re-organize the spec with three main sections:

DSNP (Chain agnostic spec)
Activity Content (Separate spec)
DSNP Implementation Specs
- Ethereum/EVM (this is what we have currently integrated now)

Example Menu Structure:

Introduction
DSNP
- Identifiers
- Graph
- Batch Publications
- Overview
- Announcements
- Overview
DSNP Implementation Specs
- EVM
- Overview
- Identity
  - Overview
  - Factory
  - Registry
- Announcements
  - Overview
  - Publishing
  - Signatures
Activity Content
- Overview
- Associated Type: Hash
- Associated: Attachments
- Associated: Location
- Associated: Tag
- Type: Note
- Type: Profile
Reference
- Glossary
Draft Specifications

Open Questions:

Should we put Activity Content into a "folder" in the menu structure?
- Currently thinking no.