Nebulis
commented
3 years ago to split documentation by integrator/developer ala https://docusaurus.io/docs (see Docs + API). Sections to be
- Integrator
- Developer / Contributor
Docs
- Overview (reuse existing)
- Introduction (reuse existing)
- How does it work (reuse existing)
- Introducton (reuse existing)
- Document integrity (reuse existing)
- Issuance status (reuse existing)
- Issuer identity (to create based on https://www.openattestation.com/docs/advanced/identity-proofs and https://www.openattestation.com/docs/advanced/configuring-dns)
- Limitations (reuse existing)
- Comparison (reuse https://www.openattestation.com/docs/verifiable-document/comparison) => make sure that it's understandable if we follow the current flow
- Appendix
- Glossary
- Contracts costs (see FAQ)
- FAQ (content of Overview/FAQ and remove contract cost)
- Roadmap
- W3C VC => content of Advanced/version 3
- Creating custom context #85
- Deprecated
- GSN
- Identity Mobile App
Integrator
- Quickstart (CLI) (reuse existing)
- Verifiable Document (reuse existing)
- Transferable Record (reuse existing)
- Webapp Tutorial
- Deploying Document Store (appendix/Deploying Document Store with Web app)
- Issuing Document Store (appendix/Issuing Document Store with Web app)
- Revoking Document Store
- FAQ
Developer
- Quickstart (Code) (to create)
- Code Tutorial #89 (Wayne)
- Creating Document Renderer => content of Advanced/Creating Document Renderer
- Creating custom schema #85
- Configure DNS (?) => must be linked in the integrator section (?)
- Libraries ? Contributor ? (this section should be a merge of exisitibng readme and components section) (Ryan)
- Open Attestation
- Open Attestation (CLI)
- Open Attestation (Encryption)
- Open Attestation (Verify) => add also
Advanced/Verification Method - Decentralised Renderer
- Document Store
- Token Registry
- FAQ
- As an OA maintainer, how do I deploy a backend service that I just updated?
To delete:
- Appendix/test account setup
WARNING
- links from tt to oa
- links from oc to oa
ryanseee
Current sectioning is quite strange. For example, the demo flow of issuing a verifiable document is under Verifiable Document > Ethereum. Why? Isn't everything on Ethereum? Docs should follow standard documentation format (included nextjs docs for reference)