MetaMask / metamask-docs

Developer documentation for MetaMask
https://docs.metamask.io
Apache License 2.0
636 stars 908 forks source link

feat(docs): added rpc-parser component for reference pages #1331

Closed TrofimovAnton85 closed 1 month ago

TrofimovAnton85 commented 1 month ago

Description

How to test:

Go to the test page for the eth_call method - https://docs.metamask.io/feat-reference-pages/wallet/reference/new-reference/ and check the main layout (description, label, request/response sections)

Links:

JIRA Issue Figma

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

TrofimovAnton85 commented 1 month ago

When pulling parameter information from the Open RPC spec, can you display the property name instead of the title value for each parameter? I.e., the information in the green box instead of the red box in the following screenshot: Screenshot 2024-06-10 at 11 25 20 AM

The property names consistently use the camel case version of the parameter name, whereas the title values are inconsistent, leading to inconsistently formatted parameters displayed: Screenshot 2024-06-10 at 11 29 41 AM

Can you also use code formatting for all the parameter names and the page title (eth_call)?

@alexandratran thanks! Fixed & committed - Screenshot 2024-06-11 at 13 42 01

TrofimovAnton85 commented 1 month ago

https://github.com/MetaMask/metamask-docs/pull/1323/files

at this stage, I need to "mirror" the functionality of the current MM plugin for RPС reference pages (and this approach is used there). But when I implement the form, I will check your option. Thanks!

vercel[bot] commented 1 month ago

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

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 12, 2024 11:14am
metamask-docs-hftx ❌ Failed (Inspect) Jun 12, 2024 11:14am
github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

github-actions[bot] commented 1 month ago

Preview published: feat-reference-pages

TrofimovAnton85 commented 1 month ago

I suggest using code formatting for the method name (eth_call) and the parameters (type, nonce, etc). Otherwise, LGTM.

(I might have to approve again if more commits are added.)

@alexandratran Thanks! Please approve again. *For now, I left the formatting for the name of the method/parameters as in the design (but I think after implementing the second part, we can think about it)