Skip to content

Commit 30d57dc

Browse files
gorondanraxhvltaxmeifyoucan
authored
added prerequisites requirement for pages subject to change (#250)
* added prerequisites requirement for pages subject to change * nit: title * Update contributing.md --------- Co-authored-by: rahul <[email protected]> Co-authored-by: Mário Havel <[email protected]>
1 parent b12038f commit 30d57dc

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/contributing.md

+31
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,37 @@ For other important links, add a section on the bottom of the page with list of
101101

102102
[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)
103103

104+
### In-page notices
105+
106+
We use blockquote notices at the top of the page to provide readers with appropriate context regarding the content of the page.
107+
108+
#### Active research
109+
110+
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:
111+
112+
```
113+
* Warning message artifact using the following format:
114+
> [!WARNING]
115+
> 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.
116+
```
117+
118+
#### Roadmap tracker
119+
120+
To help user navigate across research topics, we are using a roadmap tracker with the following format:
121+
```
122+
| Upgrade | URGE | Track | Topic | Cross-references |
123+
|:-------:|:-----------:|:---------:|:---------------------------------:|:-----------------------------------------------------------------------------------------:|
124+
| ePBS | the Scourge | MEV track | Endgame block production pipeline | intersection with: [ET](/wiki/research/ET.md), [PEPC](), [IL]() |
125+
```
126+
Ideally, references point to a local wiki pages.
127+
128+
#### Incomplete pages
129+
130+
Pages with minimal content which need more work to cover the topic need to include a notice:
131+
132+
```
133+
> :warning: This article is a [stub](https://en.wikipedia.org/wiki/Wikipedia:Stub), help the wiki by [contributing](/contributing.md) and expanding it.
134+
```
104135

105136
## Anything else?
106137

0 commit comments

Comments
 (0)