diff --git a/docs/contributing.md b/docs/contributing.md index aa8037d2..ad1f47f9 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -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?