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

50 lines
3.1 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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 22:13:47 +02:00
!!! note ""
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
If you're eager to get started, check out our [quickstart guide](./quick-start.md).
Coming from a different client? Check out the [migration guide](./migration.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
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 22:13:47 +02:00
Nimbus is a client for the Ethereum `consensus layer` (eth2) and `execution layer` (eth1) 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
This book describes the consensus layer client, `nimbus-eth2`, in particular.
Its efficiency and low resource consumption allows it to perform well on all kinds of systems, ranging from Raspberry Pi's 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).
</br>
<blockquote class="twitter-tweet"><p lang="en" dir="ltr">&quot;just because it [Nimbus] is optimized to be minimally resource intensive, doesn&#39;t mean you can&#39;t run it on a server. It means that when you do run it on a server, it is consuming a lot less resources.&quot; <a href="https://t.co/F2sdZouBtD">https://t.co/F2sdZouBtD</a></p>&mdash; Nimbus (@ethnimbus) <a href="https://twitter.com/ethnimbus/status/1376836270245154817?ref_src=twsrc%5Etfw">March 30, 2021</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</br>
This book explains the ways in which you can use Nimbus to either monitor the beacon chain or become a fully-fledged validator.
!!! note
Staking and becoming a validator on Ethereum requires 32 ETH, a stable high-speed internet connection and an always-on server. Before staking, make sure that you understand the requirements and practice setting up a validator on a testnet. [Pooled staking](https://ethereum.org/en/staking/pools/) and [Staking as a service](https://ethereum.org/en/staking/saas/) are alternative ways to stake in the network. You can also run a Nimbus node without staking.
## Helpful resources
book edits (#3903) * Reorganise menu, putting tabs on top * Use tabs for specific content * cleanups and consistency edits
2022-07-24 22:13:47 +02:00
- [Ethereum consensus spec](https://github.com/ethereum/consensus-specs/)
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
- [Ben Edgington's annotated spec](https://benjaminion.xyz/eth2-annotated-spec/phase0/beacon-chain/)
- [Vitalik's annotated spec](https://github.com/ethereum/annotated-spec/blob/master/phase0/beacon-chain.md)
- [Danny Ryan's annotated spec](https://notes.ethereum.org/@djrtwo/Bkn3zpwxB)
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
Need help with anything? Join us on [Status](https://join.status.im/nimbus-general) and [Discord](https://discord.gg/9dWwPnG).
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:
* Our donation address is [`0x70E47C843E0F6ab0991A3189c28F2957eb6d3842`](https://etherscan.io/address/0x70E47C843E0F6ab0991A3189c28F2957eb6d3842)
* 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
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