Add a brief doc page on how to add documentation (#2617)
This commit is contained in:
parent
4f0bc49a84
commit
fd3475ea3e
|
@ -0,0 +1,16 @@
|
||||||
|
# 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`
|
||||||
|
- 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).
|
|
@ -78,6 +78,7 @@ nav:
|
||||||
- Developers:
|
- Developers:
|
||||||
- 'basics-for-developers.md'
|
- 'basics-for-developers.md'
|
||||||
- 'test-suite.md'
|
- 'test-suite.md'
|
||||||
|
- 'adding-documentation.md'
|
||||||
- Local testnet:
|
- Local testnet:
|
||||||
- 'run-local-testnet.md'
|
- 'run-local-testnet.md'
|
||||||
- 'testnet-history-network.md'
|
- 'testnet-history-network.md'
|
||||||
|
|
Loading…
Reference in New Issue