WIP: feat(docs): ACT-1532 - Create Pages for the Linea JSON-RPC methods dynamically

[aednikanov]

Description

Create Pages for the Linea JSON-RPC methods dynamically

Ticket

New sidebar items with dynamic pages can be found in Services => Reference => Linea => JSON-RPC methods NEW.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
metamask-docs	✅ Ready (Inspect)	Visit Preview	💬 1 unresolved	Oct 3, 2024 5:07pm

[socket-security[bot]]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	0	11.4 kB	jdalton

🚮 Removed packages: npm/[email protected]

View full report↗︎

[bgravenorst]

I'm currently unable to test running the requests, but here are a few things I've noticed.

• The left navigation is currently broken. When I expand Linea -> JSON-RPC methods and select a method, the left navigation resets and collapses my expanded menu.

• Bold formatting not being obeyed in method description. E.g https://metamask-docs-git-act-1532-create-linea-pag-ec2dff-metamask-web.vercel.app/services/reference/linea/json-rpc-methods/eth_estimateGas/

• For methods that accept block numbers or tags (e.g eth_estimateGas, eth_getBlockByNumber), I'm not sure the descriptions are displaying correctly. The spec appears to have a oneOf schema attached.

• For eth_maxPriorityFeePerGas, the schema of the Result in the spec is not displaying. https://github.com/INFURA/sot-network-methods/blob/main/blockchains/linea/openrpc.json#L5219

[TrofimovAnton85]

I'm currently unable to test running the requests, but here are a few things I've noticed.

• The left navigation is currently broken. When I expand Linea -> JSON-RPC methods and select a method, the left navigation resets and collapses my expanded menu.
• Bold formatting not being obeyed in method description. E.g https://metamask-docs-git-act-1532-create-linea-pag-ec2dff-metamask-web.vercel.app/services/reference/linea/json-rpc-methods/eth_estimateGas/
• For methods that accept block numbers or tags (e.g eth_estimateGas, eth_getBlockByNumber), I'm not sure the descriptions are displaying correctly. The spec appears to have a oneOf schema attached.
• For eth_maxPriorityFeePerGas, the schema of the Result in the spec is not displaying. https://github.com/INFURA/sot-network-methods/blob/main/blockchains/linea/openrpc.json#L5219

Thanks for the feedback! We are currently working on the sidebar. About the others:

• I checked and now we have the processing of bold text working on double asterisk symbols (** text **) and in the description of the eth_estimateGas/ method - single
• points 3, 4 are fixed and committed

[aednikanov]

@bgravenorst hello! Thanks for testing! I fixed the 1st item from your list as well.

[alexandratran]

Should we expect to be able to run and customize requests in this PR? It doesn't seem to work for me, only the example response displays the entire time (using the latest preview deployment):

https://github.com/user-attachments/assets/f420d3df-ed0c-483b-813e-a353231f57ff

Also, @TrofimovAnton85:

I checked and now we have the processing of bold text working on double asterisk symbols (** text **) and in the description of the eth_estimateGas/ method - single

Can you enable italicized text using single asterisks or underscores (*text*) or (_text_), like in standard Markdown?

[TrofimovAnton85]

Should we expect to be able to run and customize requests in this PR? It doesn't seem to work for me, only the example response displays the entire time (using the latest preview deployment):

eth_feeHistory.mov Also, @TrofimovAnton85:

I checked and now we have the processing of bold text working on double asterisk symbols (** text **) and in the description of the eth_estimateGas/ method - single

Can you enable italicized text using single asterisks or underscores (*text*) or (_text_), like in standard Markdown?

Thanks for the feedback! I added italic support + some improvements to UI/UX for a request (now you can see the pending request state with the loader on the button). More details on this thread: https://consensys.slack.com/archives/C075PCUF0TF/p1727786495606279