mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-01-28 23:34:59 +00:00

* part 2 of the initial doc fixes

- spelling fixes
- grammar fixes
- em-dashes should be em-dashes (`—`): double dashes (`--`) are not rendered properly
- reduce overusage of em-dashes, some of those should be separate sentences
- use the correct syntax for notes, tips and warnings
- every sentence is in a separate line (helps with future diffs)
- add missing dots at the end of list items
- fix some lists

* sentences on separate lines in the remaining files

2023-04-11 18:42:35 +03:00

1.5 KiB

Raw Blame History

Updating this guide

We use Material for MkDocs to produce our documentation.

Before You Start

Clone the repository by git clone https://github.com/status-im/nimbus-eth2.git.
Go to the docs folder and type make to install mkdocs
Activate mkdocs: . mkdocs/bin/activate
Go to where the Markdown files are located by cd the_nimbus_book/.

Real-Time Update and Preview Changes

Run mkdocs serve in the terminal.
Preview the book at http://localhost:8000.

Build and Deploy

The first step is to submit a pull request to the unstable branch. Then, after it is merged, do the following under our main repository:

cd nimbus-eth2
git checkout unstable
git pull
make update # (This is to update the submodules to the latest version)
make publish-book

Troubleshooting

If you see file conflicts in the pull request, this may due to that you have created your new branch from an old version of the unstable branch. Update your new branch using the following commands:

git checkout unstable
git pull
make update
git checkout readme
git merge unstable
# use something like "git mergetool" to resolve conflicts, then read the instructions for completing the merge (usually just a `git commit`)
# check the output of "git diff unstable"

Thank you so much for your help to the decentralized and open source community. :)

1.5 KiB Raw Blame History