Skip to content

Commit

Permalink
Update (#123)
Browse files Browse the repository at this point in the history
* update home

* rename docs to overview

* update overview: language sync

* home edits
  • Loading branch information
unixpi authored Nov 3, 2021
1 parent 7a058dd commit f1386e4
Show file tree
Hide file tree
Showing 11 changed files with 24 additions and 22 deletions.
8 changes: 4 additions & 4 deletions source/docs/contributor_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 2 additions & 0 deletions source/docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions source/docs/eth1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
6 changes: 3 additions & 3 deletions source/docs/eth2.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
2 changes: 1 addition & 1 deletion source/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion source/docs/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion themes/navy/languages/en.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
menu:
docs: Docs
overview: Overview
plugins: Plugins
themes: Themes
search: Search
Expand Down
14 changes: 7 additions & 7 deletions themes/navy/layout/index.swig
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@
<div id="about" class="section-header section-header--main">
<h2 id="top-header">We build lighter Ethereum clients</h2>
<p>
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.
</p>
<a href="/docs">See our docs <img src="../img/arrow_orange.svg" /></a>
<a href="/docs">See our overview <img src="../img/arrow_orange.svg" /></a>
<div class="work-item">
<img class="work-item-image work-item-image-right" src="../img/graphic-platform-support.svg" />
<div class="work-item-inner">
<h2>Consensus layer (eth2)</h2>
<p>You can use Nimbus today to both monitor the eth2 chain and join the network as a fully-fledged validator.
<p>You can use Nimbus today to both monitor the beacon chain and join the network as a fully-fledged validator.
</p>
<a href="https://nimbus.guide">See our guide <img src="../img/arrow_orange.svg" /></a>
</div>
</div>
<div class="work-item">
<div class="work-item-inner">
<h2>Execution layer (eth1)</h2>
<p>We are working hard on a lightweight Ethereum 1 client to complement our Ethereum 2 client.
<p>We are working hard on a lightweight execution layer client to complement our consensus layer client.
</p>
<a href="https://github.com/status-im/nimbus-eth1">Keep up with our progress <img src="../img/arrow_orange.svg" /></a>

Expand All @@ -47,7 +47,7 @@ Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strive
<div class="work-item">
<div class="work-item-inner">
<h2>Free and open source philosophy</h2>
<p>We’re building Nimbus as a common good with liberal licensing to allow for the widest deployment of Ethereum 2.0 possible.
<p>We’re building Nimbus as a common good with liberal licensing to allow for the widest deployment of Ethereum possible.
</p>
</div>
<img class="work-item-image work-item-image-right" src="../img/graphic-licensing.svg" />
Expand All @@ -67,8 +67,8 @@ Nimbus is a client implementation for both Ethereum 1 and Ethereum 2 that strive
<span><a href="https://status.im/our_team/open_positions.html"><img src="../img/arrow_ogn.png" /></a></span>
</div>
<div class="contribute">
<h3>Suppport</h3>
<p>As an Ethereum public good, largely dependent on both Status and the Ethereum Foundation for funding, grants are our lifeblood. See <a href="https://etherscan.io/address/0x70E47C843E0F6ab0991A3189c28F2957eb6d3842">here</a> for our donation address</p>
<h3>Support</h3>
<p>As a web3 public good, largely dependent on both Status and the Ethereum Foundation for funding, grants are our lifeblood. See <a href="https://etherscan.io/address/0x70E47C843E0F6ab0991A3189c28F2957eb6d3842">here</a> for our donation address</p>
<p>
<a href="https://gitcoin.co/grants/137/nimbus">Support us on Gitcoin</a>
<span><a href="https://gitcoin.co/explorer?keywords=nimbus&order_by=-web3_created"><img src="../img/arrow_ogn.png" /></a></span>
Expand Down
2 changes: 1 addition & 1 deletion themes/navy/layout/partial/footer.swig
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<div class="footer-table__column margin-top-15">
<p class="footer-header">More</p>
<ul class="footer-list">
<li class="footer-link"><a href="https://status.im/docs/" target="_blank">Docs</a></li>
<li class="footer-link"><a href="https://nimbus.team/docs/" target="_blank">Overview</a></li>
<li class="footer-link"><a href="/docs/libraries.html" target="_blank">Github</a></li>
<li class="footer-link"><a href="https://news.nimbus.team/" target="_blank">News</a></li>
<li class="footer-link"><a href="https://subscribe.nimbus.team/" target="_blank">Newsletter</a></li>
Expand Down
2 changes: 1 addition & 1 deletion themes/navy/layout/partial/header-nav.swig
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<li id="about-header" class="item--to-show"><a href="#about">About</a></li>
<li><a href="#contribute">Contribute</a></li>
<li class="item--to-show"><a href="#team">Team</a></li>
<li class="item--to-show"> <a href="/docs">Docs</a></li>
<li class="item--to-show"> <a href="/docs">Overview</a></li>
<li class="item--to-show"> <a href="https://our.status.im/tag/nimbus/">News</a> </li>
<li class="item--to-show"> <a href="https://subscribe.nimbus.team/">Newsletter</a> </li>
</ul>
2 changes: 1 addition & 1 deletion themes/navy/layout/partial/header.swig
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<ul class="mobile-nav">
<li><a href="https://our.status.im/tag/nimbus/">News</a></li>
<li><a href="http://subscribe.nimbus.team/">Newsletter</a></li>
<li><a href="/docs">Docs</a></li>
<li><a href="/overview">Overview</a></li>
<li class="item--dropdown item--to-show">
<span>Projects</span>
<ul class="mobile-sub-nav">
Expand Down

0 comments on commit f1386e4

Please sign in to comment.