diff --git a/source/docs/contributor_guide.md b/source/docs/contributor_guide.md index 156091b..1996883 100644 --- a/source/docs/contributor_guide.md +++ b/source/docs/contributor_guide.md @@ -41,7 +41,7 @@ If you have research ideas you'd like to throw at us, exotic hardware you'd like Whatever you might expect to see in other projects applies here: -- be nice to others -- when evaluating PRs, focus exclusively on the quality of the code -- if submitting code, make sure it's tested. All code MUST come with tests. To speed up the review, ping a [team member](/docs/team). -- if submitting typo fixes or documentation changes, speed up the review process by pinging a team member. [arnetheduck](https://github.com/arnetheduck) or [sachayves](https://github.com/sachayves) will usually review those very quickly. The same applies if submitting a tutorial for inclusion on the [official blog](https://our.status.im/tag/nimbus). +- Be nice to others +- When evaluating PRs, focus exclusively on the quality of the code +- If submitting code, make sure it's tested. All code MUST come with tests. To speed up the review, ping a [team member](/docs/team). +- If submitting typo fixes or documentation changes, speed up the review process by pinging a team member. [Jacek](https://github.com/arnetheduck) or [Sacha](https://github.com/unixpi) will usually review those very quickly. The same applies if submitting a tutorial for inclusion on the [official blog](https://our.status.im/tag/nimbus). diff --git a/source/docs/design.md b/source/docs/design.md index b2d1da1..939756f 100644 --- a/source/docs/design.md +++ b/source/docs/design.md @@ -23,6 +23,8 @@ The dream is for you to be able to run an eth2 validator on Status desktop. We are committed to open standards and to maintaining consensus with other Ethereum-compliant implementations. As such, the development of Nimbus and the changes in its protocols follow [the EIP process](https://github.com/ethereum/EIPs/). +We played a role in drafting [EIP-3076: Slashing Protection Interchange Format](https://eips.ethereum.org/EIPS/eip-3076). + ## Licensing: MIT, Apache v2.0 diff --git a/source/docs/eth1.md b/source/docs/eth1.md index 69fccac..e596038 100644 --- a/source/docs/eth1.md +++ b/source/docs/eth1.md @@ -3,11 +3,11 @@ id: eth1 title: Execution layer (eth1) --- -While our core focus so far has been Ethereum 2 (consensus layer), we are now devoting significant resources to our Ethereum 1 client (execution layer). +While our core focus so far has been the consensus layer, we are now devoting significant resources to our execution layer cleint. ## Quickstart -To run Nimbus in [Ethereum 1 mode](https://github.com/status-im/nimbus-eth1), first [install the prerequisites](https://github.com/status-im/nimbus-eth1#prerequisites). +To run Nimbus' [execution layer client](https://github.com/status-im/nimbus-eth1), first [install the prerequisites](https://github.com/status-im/nimbus-eth1#prerequisites). Then run the following commands: diff --git a/source/docs/eth2.md b/source/docs/eth2.md index 6db5120..4f5ad94 100644 --- a/source/docs/eth2.md +++ b/source/docs/eth2.md @@ -3,11 +3,11 @@ id: eth2 title: Consensus layer (eth2) --- -Depending on your objective, there are various ways to run Nimbus in [Ethereum 2 mode](https://github.com/status-im/nimbus-eth2). +Depending on your objective, there are various ways to run Nimbus' [consensus layer client](https://github.com/status-im/nimbus-eth2). -The reference documentation is [the Nimbus Book](https://nimbus.guide): it explains all the ways in which you can play with Nimbus, and use Nimbus to either monitor the eth2 chain or become a fully-fledged validator. +The reference documentation is [the Nimbus Book](https://nimbus.guide): it explains all the ways in which you can play with Nimbus, and use Nimbus to either monitor the beacon chain or become a fully-fledged validator. -We encourage you to check it out here: https://nimbus.guide +We encourage you to check it out. diff --git a/source/docs/index.md b/source/docs/index.md index 8f8dd19..8cba96a 100644 --- a/source/docs/index.md +++ b/source/docs/index.md @@ -3,7 +3,7 @@ title: A lighter Ethereum Client ## Overview -Nimbus is a client implementation for both Ethereum's consensus layer (Ethereum 2) and execution layer (Ethereum 1) that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, embedded devices -- including Raspberry Pis and mobile devices. +Nimbus is a client implementation for both Ethereum's consensus layer (eth2) and execution layer (eth1) that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, embedded devices -- including Raspberry Pis and mobile devices. However, **resource-restricted hardware is not the only thing Nimbus is good for.** Its low resource consumption makes it **easy to run Nimbus together with other workloads on your server** (this is especially valuable for stakers looking to lower the cost of their server instances). diff --git a/source/docs/libraries.md b/source/docs/libraries.md index 7afc78b..bd53340 100644 --- a/source/docs/libraries.md +++ b/source/docs/libraries.md @@ -3,7 +3,7 @@ id: libraries title: Explore our libraries --- -In addition to our [eth1](https://github.com/status-im/nimbus-eth1) (execution layer) and [eth2](https://github.com/status-im/nimbus-eth2) (consensus layer) clients we have developed several high-quality libraries (the product of our ethereum work in Nim). These include: +In addition to our [execution layer](https://github.com/status-im/nimbus-eth1) and [consensus layer](https://github.com/status-im/nimbus-eth2) clients we have developed several high-quality libraries (the product of our ethereum work in Nim). These include: - Nim libp2p: https://github.com/status-im/nim-libp2p diff --git a/themes/navy/languages/en.yml b/themes/navy/languages/en.yml index 95022af..92c74c1 100644 --- a/themes/navy/languages/en.yml +++ b/themes/navy/languages/en.yml @@ -1,5 +1,5 @@ menu: - docs: Docs + overview: Overview plugins: Plugins themes: Themes search: Search diff --git a/themes/navy/layout/index.swig b/themes/navy/layout/index.swig index f38cefe..5c6a119 100644 --- a/themes/navy/layout/index.swig +++ b/themes/navy/layout/index.swig @@ -13,14 +13,14 @@

We build lighter Ethereum clients

-Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, resource-restricted devices -- including Raspberry Pis and mobile devices -- and multi-purpose servers. +Nimbus is a client implementation that strives to be as lightweight as possible in terms of resources used. This allows it to perform well on embedded systems, resource-restricted devices -- including Raspberry Pis and mobile devices -- and multi-purpose servers.

- See our docs + See our overview

Consensus layer (eth2)

-

You can use Nimbus today to both monitor the eth2 chain and join the network as a fully-fledged validator. +

You can use Nimbus today to both monitor the beacon chain and join the network as a fully-fledged validator.

See our guide
@@ -28,7 +28,7 @@ Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strive

Execution layer (eth1)

-

We are working hard on a lightweight Ethereum 1 client to complement our Ethereum 2 client. +

We are working hard on a lightweight execution layer client to complement our consensus layer client.

Keep up with our progress @@ -47,7 +47,7 @@ Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strive

Free and open source philosophy

-

We’re building Nimbus as a common good with liberal licensing to allow for the widest deployment of Ethereum 2.0 possible. +

We’re building Nimbus as a common good with liberal licensing to allow for the widest deployment of Ethereum possible.

@@ -67,8 +67,8 @@ Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strive
-

Suppport

-

As an Ethereum public good, largely dependent on both Status and the Ethereum Foundation for funding, grants are our lifeblood. See here for our donation address

+

Support

+

As a web3 public good, largely dependent on both Status and the Ethereum Foundation for funding, grants are our lifeblood. See here for our donation address

Support us on Gitcoin diff --git a/themes/navy/layout/partial/footer.swig b/themes/navy/layout/partial/footer.swig index da5d14d..8343cdc 100644 --- a/themes/navy/layout/partial/footer.swig +++ b/themes/navy/layout/partial/footer.swig @@ -16,7 +16,7 @@

More

diff --git a/themes/navy/layout/partial/header.swig b/themes/navy/layout/partial/header.swig index f112051..8438200 100644 --- a/themes/navy/layout/partial/header.swig +++ b/themes/navy/layout/partial/header.swig @@ -20,7 +20,7 @@