ethereum-optimism / ethereum-optimism/specs

Clean up RPC docs filesystem

Open
#677 0 comments 0 reactions 0 assignees View on GitHub
A-rpc C-debt C-good-first-issue
Dominant language
Python
Stars
178
Forks
205
Avg merge
5d 2h
Merged PRs (30d)
6

Description

- Move the existing RPC specs all into one /protocol/rpc directory. E.g. the supervisor RPC is already specified.
- Add references to the docs we moved these out of.
- Create a document for each RPC namespace. E.g. rpc-admin.md, rpc-optimism.md, rpc-engine.md, rpc-interop.md, rpc-supervisor.md, rpc-opp2p.md, etc.

Contributor guide

Open the contributing guide

Research direction

Inventory the existing RPC specifications and the documents that reference them. Organize the specs under /protocol/rpc, including separate documents such as rpc-admin.md, rpc-optimism.md, rpc-engine.md, rpc-interop.md, rpc-supervisor.md, and rpc-opp2p.md. Done means the specs are consolidated and the original documentation points to their new locations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.