[ EPIC ] Developer Documentation

[jpaulet]

As a developer/integrator, I need good documentation and a clear getting started guide for using the SDK and all the tools that Vocdoni offers to me.

Write new docs

From getting started section:

• Create the "Getting Started Guide" (now we are using the SDK readme, maybe can be this?)
• Add UI-Components docs
• FAQs

Tutorials (inside getting started):

• Create your first election
• How to configure the lifecycle of an election
• Census types and how to create them
• Retrieving elections results
• Vote in an election
• Create your first quadratic voting

Protocol (inside Reference):

• Encryption and validators
• Faucet package
• Transactions
• Results
• Accounts and organizations
• Libraries and tooling
• Pricing

Vochain (inside Reference):

• Run a node
• Deployed networks
• ...?

Old Docs:

• Retrieve and propose what we can reuse from docs.vocdoni.io
• Merge the 2 docs in 1
• Redirect docs.vocdoni.io to developer.vocdoni.io

More tasks:

• Plausible events for new sections
• Add SDK changelog into the Developer Portal

More references: https://www.notion.so/aragonorg/Developer-Portal-a8c15bc54bcb4e759fc8eda248c7afe3

[selankon]

I added a tasks Plausible events for new sections to the backlog

[selankon]

The current docusaurus changelog plugin is a custom plugin located here:

https://github.com/facebook/docusaurus/tree/main/website/src/plugins/changelog

And is not placed for download. For the moment we could just copy the changelog among sdk README to the correct place on the CI.

[selankon]

Changelog marked as resolved

#68
vocdoni/vocdoni-sdk#162

[selankon]

Merge the 2 docs in 1 task will be completed after

#69