Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Have proper, clearly labelled sections #88

Open
waynewee opened this issue Oct 1, 2021 · 2 comments
Open

Have proper, clearly labelled sections #88

waynewee opened this issue Oct 1, 2021 · 2 comments

Comments

@waynewee
Copy link
Contributor

waynewee commented Oct 1, 2021

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)

image

@Nebulis
Copy link
Contributor

Nebulis commented Oct 1, 2021

to split documentation by integrator/developer ala https://docusaurus.io/docs (see Docs + API). Sections to be

  • Integrator
  • Developer / Contributor

Docs

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)
  • 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
Copy link
Contributor

ryanseee commented Oct 12, 2021

Migration Progress

Docs

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)
  • 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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants