Docs: deploy a docusaurus-like website #1233
Description
The website has different users:
- the node runner
- the engineers
- the protocol researchers
- the cryptography researchers
The documentation website should:
- test all the scripts that are given to the users in the documentation, so we know that we are constantly providing the correct commands and code
- host the Rust documentation
- provides the instructions to run (docker-based or not):
- a block producer
- a light node
- an archive node
- generate key pairs
- contain instructions to participate in the devnet
- link to the GitHub repository
- explain the design choices of the codebase; it should be an entry point for developers.
- provide a versioning.
The makefile should contain a target to build the documentation, and should give a link to the developer to serve the website locally.
The CI should build the documentation in a new workflow (coined ./website), and use the Makefile target.
We suggest a solution based on docusaurus. It provides an easy integration with Markdown, and also provides versioning. It is a relatively common choice for this kind of documentation. We are open to other suggestions.
When a commit is made on develop, the documentation must be updated for the version develop.
When a tag is created, the documentation must be deployed with the version the tag references to.
If it adds a new kind of dependency, like NPM, the dependabot configuration must be updated accordingly.
The CHANGELOG should also be updated accordingly, with a single line mentioning the deployment of the new documentation.
The following links should be added on the website:
- Mina Protocol Discord
- Mina protocol websites
- o1labs website
- o1Labs Twitter/X
Metadata
Metadata
Assignees
Type
Projects
Status