Skip to content

Commit

Permalink
Add a brief doc page on how to add documentation (#2617)
Browse files Browse the repository at this point in the history
  • Loading branch information
kdeme authored Sep 12, 2024
1 parent 4f0bc49 commit fd3475e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
16 changes: 16 additions & 0 deletions fluffy/docs/the_fluffy_book/docs/adding-documentation.md
Original file line number Diff line number Diff line change
@@ -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).
1 change: 1 addition & 0 deletions fluffy/docs/the_fluffy_book/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ nav:
- Developers:
- 'basics-for-developers.md'
- 'test-suite.md'
- 'adding-documentation.md'
- Local testnet:
- 'run-local-testnet.md'
- 'testnet-history-network.md'
Expand Down

0 comments on commit fd3475e

Please sign in to comment.