mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-02-22 16:58:21 +00:00
c652f5efc2
* Don't proxy implemented state JSON-RPC endpoints. Fix minor issue in testnet script. * Add docs covering usage of the Fluffy state bridge.
18 lines
828 B
Markdown
18 lines
828 B
Markdown
# Adding Documentation
|
|
|
|
The documentation visible on [https://fluffy.guide](https://fluffy.guide) is generated with [mkdocs](https://www.mkdocs.org/getting-started/).
|
|
|
|
If you want to be able to dry run any changes you make, you best install mkdocs locally.
|
|
|
|
All the documentation related files can be found under the `./fluffy/docs/the_fluffy_book` directory.
|
|
|
|
## How to test and add documentation changes
|
|
|
|
- Install `mkdocs`
|
|
- Install Material for MkDocs by running `pip install mkdocs-material`.
|
|
- Make your changes to the documentation
|
|
- Run `mkdocs serve` from the `./fluffy/docs/the_fluffy_book` directory and test your changes. Alter as required.
|
|
- Push your changes to a PR on nimbus-eth1
|
|
|
|
When the PR gets merged, a CI job will run that deploys automatically the changes to [https://fluffy.guide](https://fluffy.guide).
|