Skip to content

Commit

Permalink
Wiki pages update, May 7
Browse files Browse the repository at this point in the history
  • Loading branch information
taxmeifyoucan committed May 7, 2024
2 parents b798f61 + b9e25ef commit 663193b
Show file tree
Hide file tree
Showing 12 changed files with 1,901 additions and 39 deletions.
5 changes: 4 additions & 1 deletion docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,16 @@
- [Transaction anatomy](/wiki/EL/transaction.md)
- [JSON-RPC](/wiki/EL/JSON-RPC.md)
- [DevP2P](/wiki/EL/devp2p.md)
- [RLP Serialization](/docs/wiki/EL/RLP.md)
- [RLP Serialization](/wiki/EL/RLP.md)
- Consensus Layer
- [Overview](/wiki/CL/overview.md)
- [CL Specs](/wiki/CL/cl-specs.md)
- [Client architecture](/wiki/CL/client-architecture.md)
- [CL Clients](/wiki/CL/cl-clients.md)
- [Beacon API](/wiki/CL/beacon-api.md)
- [CL Networking](/wiki/CL/cl-networking.md)
- [SSZ Serialization](/wiki/CL/SSZ.md)
- [Merkleization](/wiki/CL/merkleization.md)
- Development
- [Core development](/wiki/dev/core-development.md)
- [Coordination](/wiki/dev/pm.md)
Expand All @@ -53,6 +55,7 @@
- [Testing overview](/wiki/testing/overview.md)
- [Incidents](/wiki/testing/incidents.md)
- [hive](/wiki/testing/hive.md)
- [Formal verification](/wiki/testing/formal-verification.md)
- Research
- [Roadmap overview](/wiki/research/roadmap.md)
- [Scaling](/wiki/research/scaling/scaling.md)
Expand Down
15 changes: 14 additions & 1 deletion docs/assets/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -172,14 +172,27 @@ body .markdown-section {
--navbar-root-color--active: #ba9afd;
--search-input-background-color: #2d1763;
--table-row-odd-background: #2d1763;
--base-color: #fff;
--heading-color: #fff;
--primary-text-color: #d3d3d3;

/* blockquote*/
--blockquote-background: #2d1763;
--blockquote-color: #fff;
--blockquote-color: var(--primary-text-color);
--blockquote-border-color: #ba9afd;

/* link */
--link-color: #ba9afd;

/* text */
}

body {
color: #fff;
}

section.content , .markdown-section code{
color: var(--primary-text-color);
}

/* sidebar */
Expand Down
31 changes: 31 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,37 @@ For other important links, add a section on the bottom of the page with list of

[JSON-RPC API reference](https://ethereum.org/en/developers/docs/apis/json-rpc), [archived](https://web.archive.org/web/20240117035335/https://ethereum.org/en/developers/docs/apis/json-rpc)

### In-page notices

We use blockquote notices at the top of the page to provide readers with appropriate context regarding the content of the page.

#### Active research

Wiki pages that are subject to future updates, i.e. pages covering active research topics require a notice to be added on top of the pages:

```
* Warning message artifact using the following format:
> [!WARNING]
> This document covers an active area of research, may be outdated at time of reading and subject to future updates, as the design space around evolves.
```

#### Roadmap tracker

To help user navigate across research topics, we are using a roadmap tracker with the following format:
```
| Upgrade | URGE | Track | Topic | Cross-references |
|:-------:|:-----------:|:---------:|:---------------------------------:|:-----------------------------------------------------------------------------------------:|
| ePBS | the Scourge | MEV track | Endgame block production pipeline | intersection with: [ET](/wiki/research/ET.md), [PEPC](), [IL]() |
```
Ideally, references point to a local wiki pages.

#### Incomplete pages

Pages with minimal content which need more work to cover the topic need to include a notice:

```
> :warning: This article is a [stub](https://en.wikipedia.org/wiki/Wikipedia:Stub), help the wiki by [contributing](/contributing.md) and expanding it.
```

## Anything else?

Expand Down
Binary file added docs/images/merkelization-IndexedAttestation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 663193b

Please sign in to comment.