status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-02-25 04:35:31 +00:00
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book
History
Miran 05d99185c9
Various docs fixes (#4789) 
- spelling fixes
- use the correct sintax for notes
- em-dashes should be em-dashes (`—`): double dashes (`--`) are not
  rendered properly
- fix a link (was to a .html, should be to .md)
- add missing dots
- every sentence should be on a separate line: it makes future diffs
  much nicer and easier to spot the changes
2023-04-05 16:58:58 +03:00
..
src
Various docs fixes (#4789)
2023-04-05 16:58:58 +03:00
.gitignore
Migrate docs to mkdocs (#3900)
2022-07-22 21:47:24 +02:00
CNAME
add cname file to docs to fix domain issues (#2260)
2021-01-22 17:57:55 +01:00
mkdocs.yml
History pruning (fixes #4419) (#4445)
2023-01-07 10:02:15 +00:00
README.md
book edits (#3955)
2022-08-13 20:17:20 +02:00

README.md

The Nimbus Guide is written using markdown and material for mkdocs.

See the Makefile for setup.

The guide is divided into several sections - broadly:

  • Guides - walk-throughs that allow the user to get started with a specific area of the client
  • How-to:s - short pages that show the user how to solve a specific problem or perform a specific task
  • Reference - pages describing how specific parts of Nimbus work, reference-style
  • "Other" - explanations of concepts, background etc.

Resources