status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-01-10 22:36:01 +00:00
Code Issues Projects Releases Wiki Activity
nimbus-eth2/docs/the_nimbus_book/src/index.md

72 lines
3.8 KiB
Markdown
Raw Normal View History

Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
# The Nimbus Guide
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 07:59:55 +01:00
Nimbus is a client for the Ethereum network that is [lightweight](https://our.status.im/ethereum-is-green/), [secure](./audit.md) and [easy to use](./run-a-validator.md).
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-10 01:06:01 +02:00
Its efficiency and low resource consumption allows it to perform well on all kinds of systems: ranging from Raspberry Pi and mobile devices — where it contributes to low power consumption and security — to powerful servers where it leaves resources free to perform other tasks, such as running an [execution node](./eth1.md).
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
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 15:58:58 +02:00
This book describes the consensus layer client, [`nimbus-eth2`](https://github.com/status-im/nimbus-eth2).
correct execution client link in docs (#5159)
2023-07-04 10:54:32 +00:00
An execution client, [nimbus-eth1](https://github.com/status-im/nimbus-eth1), is also under development.
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-10 01:06:01 +02:00
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 07:59:55 +01:00
## Feature highlights
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 07:59:55 +01:00
* [Beacon node](./quick-start.md) with integrated validator client, slashing protection and doppelganger detection
* Stand-alone [validator client](./validator-client.md) with [sentry node](./validator-client.md#sentry-node-setup) support
change all :s to s (#4403) * change all :s to s * edit one more :s
2022-12-09 17:42:52 +08:00
* Fast [Beacon](./rest-api.md) and [KeyManager](./keymanager-api.md) APIs with extensions
doc updates (#4314) * optimise index / landing page real estate, add feature list * fee recipient in quickstart * recommend http over websockets (fewer command line options needed) * simplify PBS, fee recipient docs * add VC role / sentry node docs (#4140) * Update docs/the_nimbus_book/src/rest-api.md Co-authored-by: tersec <tersec@users.noreply.github.com>
2022-11-13 07:59:55 +01:00
* [Web3Signer](https://docs.web3signer.consensys.net/en/latest/) remote signing
* [Validator monitoring](./validator-monitor.md) and [performance analysis](./attestation-performance.md) tooling
* [External block builder](./external-block-builder.md) (PBS / mev-boost) support with execution client fallback
Nimbus guide: Fix link to consensus light client page (#4336)
2022-11-18 18:22:10 +01:00
* [Light consensus client](./el-light-client.md) for running an execution client without a full beacon node
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
Update "Getting started" part of the book (#4938) * refactor index.md * move philosophy.md into index.md * clean up the 'getting started' topic move how-to's to the how-to section * cleaner titles * move prerequisites to the install.md page * hardware.md: small refactor * improve quick-start.md * refactor eth1.md * refactor validating guide * reverse the order of BN and LC in the table * pi-guide.md: minor edit * Apply suggestions from code review Co-authored-by: tersec <tersec@users.noreply.github.com> * make link texts more concrete * remove comparison to other clients * add some more explanations to `build.md` * change 'days' to 'hours' --------- Co-authored-by: tersec <tersec@users.noreply.github.com>
2023-06-10 01:06:01 +02:00
## Design goals
One of our most important design goals is an application architecture that makes it **simple to embed Nimbus into other software.**
Another goal is to **minimize reliance on third-party software.**
A third one is for the application binary to be as **lightweight as possible in terms of resources used.**
### Integration with Status
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">I can&#39;t wait to run Nimbus straight from Status Desktop <a href="https://twitter.com/hashtag/hyped?src=hash&amp;ref_src=twsrc%5Etfw">#hyped</a></p>&mdash; JARRAÐ HOPΞ (@jarradhope) <a href="https://twitter.com/jarradhope/status/1293473249347555334?ref_src=twsrc%5Etfw">August 12, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
As part of our first design goal, our primary objective here is for Nimbus to be tightly integrated into the [Status messaging app](https://status.im/).
Our dream is for you to be able to run and monitor your validator straight from Status desktop.
## Book contents
You can read this book from start to finish, or you might want to read just specific topics you're interested in:
* If you're eager to get started, the [quickstart guide](./quick-start.md) is for you.
* Coming from a different client? Check out the [migration guide](./migration.md).
* Visualize the important metrics with [Grafana and Prometheus](./metrics-pretty-pictures.md).
* Interested in becoming a validator? Follow the [validator guide](./run-a-validator.md).
* If you're not planning on becoming a validator, you can run the [light client](./el-light-client.md).
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 20:17:20 +02:00
## Get in touch
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
Doc fixes, part 2 (#4806) * 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 17:42:35 +02:00
Need help with anything?
Join us on [Status](https://join.status.im/nimbus-general) and [Discord](https://discord.gg/9dWwPnG).
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 20:17:20 +02:00
## Donate
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
If you'd like to contribute to Nimbus development:
Update index.md Updated the donation address as per announcement.
2023-04-16 17:00:26 +10:00
* Our donation address is [`0xDeb4A0e8d9a8dB30a9f53AF2dCc9Eb27060c6557`](https://etherscan.io/address/0xDeb4A0e8d9a8dB30a9f53AF2dCc9Eb27060c6557)
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
* We're also listed on [GitCoin](https://gitcoin.co/grants/137/nimbus-2)
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 20:17:20 +02:00
## Stay updated
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
Subscribe to our newsletter [here](https://subscribe.nimbus.guide/).
book edits (#3955) * reorganise navigation menus * update light client guide with comparison table * add suggested fee recipient and JWT secrets to the merge guide * add some background info to book readme * add JWT docs also limit toc to make it displayable with substeps.
2022-08-13 20:17:20 +02:00
## Disclaimer
Migrate docs to mkdocs (#3900) `mkdocs` works with markdown similar to `mdbook` but is generally more pleasing to the eye and has several nice UX features. This PR does the bulk of the transition - likely, a followup would be needed to fully make use of the extra features and navigation. Book pages have been kept url-compatible, meaning that for the most part, old links should continue to work! Co-authored-by: Etan Kissling <etan@status.im>
2022-07-22 21:47:24 +02:00
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 15:58:58 +02:00
This documentation assumes Nimbus is in its ideal state.
The project is still under active development.
Please submit a [Github issue](https://github.com/status-im/nimbus-eth2/issues) if you come across a problem.
Reference in New Issue Copy Permalink