Skip to content

Conversation

bomanaps
Copy link
Contributor

This closes #655, am yet to remove the initial JSON-RPC

Screenshot 2025-05-20 at 12 24 08 Screenshot 2025-05-20 at 12 24 18 Screenshot 2025-05-20 at 12 24 26 Screenshot 2025-05-20 at 12 24 36

Copy link
Member

@lightclient lightclient left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we auto generate these? Would rather not need to manually add new methods into the sidebar each time. Also the direct links to the method doesn't work for me, seems to be missing a /docs prefix.

@bomanaps bomanaps requested a review from lightclient May 21, 2025 14:33
@zcstarr
Copy link
Contributor

zcstarr commented Aug 21, 2025

Actually missed this amongst things in PRs, as we're looking at the refactoring of docs , this is a nice feature to be able to drill down methods by some logical grouping. I think the way forward for this would be to add tags for all the methods, and we can add a open-rpc linter rule for that I think (' something like at least 1 tag required').

with an new rule to the new linter, so people writing specs must include a tag with the method. That would allow for the categorization to be a part of the spec, and the we can present that in the view layer or not, however view layers would like to consume it. I think it would just be a consumption signal and something devs can grep for or even code against to filter, and would be more resilient than naming convention, especially if it bridges multiple concerns.

https://spec.open-rpc.org/#tag-object
We'd probably want to make a tags.yml and then reference those tags in the relevant methods. it'd make the docs really consistent .

An example tag here:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate debug, engine, and eth namespaces in docs
3 participants