Following up on the Jan. Developer Update and a thoughtful post from @james a year ago, here’s a suggested outline of the ‘Getting Started’ documentation we’d like to create. (And @e-ntitle.patrick, point taken about the framing around why-and-therefore-where decentralization. Thank you).
We welcome any thoughts.
Getting Started
- Overview (product manager as well as developer audience)
- Why DSNP and how DSNP works with the blockchain we select
- Include simple explanation based on a hypothetical use case that explains what’s decentralized and why
- General use case-focused diagram of how DSNP + the blockchain work
- Additional use cases: ideas for using DSNP, how we see the ecosystem likely growing
- General FAQ
- Why DSNP and how DSNP works with the blockchain we select
- Developer Guides + Materials
- Developer Guide: useful DSNP-level how-to documentation to help you actually build with DSNP, including production tips
- Dev set-up scripts + step-by-step guides:
- Docker
- Bash
- Essential Resources
- Libraries + Tools
- SDKs
- Example Client
- Possibly also a read-only version of the Example Client that could be deployed via GitHub pages? See Deploy Read-only version to GitHub Pages · Issue #144 · LibertyDSNP/example-client · GitHub
- Sample service node
- Testnet
- How to bring up a test net
- How to connect to our test net
- Explainers
- Diagrams of typical workflows and interactions
- Deeper dives into specific topics (some are likely to be just explainers, some will be explainers along with best practices):
- Privacy: overview of how this is handled in the spec, what we are encouraging in the ecosystem (and how; difference between privacy properties of the network v. clients), and recommendations
- Identity
- What aspects of digital identity are handled in DSNP and what would be handled elsewhere
- Scalability
- Storage
- Sharing Content
- Demonstration of encrypted content
- Demonstration of storing/sharing a large file in the context of the DSNP
- Demonstration of filtering
- Sample apps (future work…)
- Developer FAQ
- Glossary
- (Spec glossary already exists)
- Videos
- Likely to begin posting weekly DSNP spec meetings
- Intro Workshops (possible future work if we hear there’s interest)
- Tutorials + Sample Code
- Demonstration of connecting to DSNP and using it from golang,
javascript, python, kotlin, etc. - Demonstration of permissioned access to an asset
- Demonstration of connecting to DSNP and using it from golang,