Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the layout of the JSON RPC page #383

Open
wants to merge 2 commits into
base: staging-ah-smart-contracts
Choose a base branch
from

Conversation

eshaben
Copy link
Collaborator

@eshaben eshaben commented Feb 13, 2025

This PR reformats the JSON RPC page as follows:

  • Removes the section categorization because I feel like people are going to use this page as a quick reference so it should just be alphabetized so users can more easily find what they're looking for
  • Sets the section headers to be the rpc method name for the same reason as above
  • Defines parameters even when there are none and sets the parameter types along with links back to the Ethereum docs for more info on data, quantities, and default block parameters
  • Moves the examples out of admonitions, as they shouldn't be hidden or be highlighted. Especially since the main purpose of this page is to showcase what's available along with quick copy/paste examples

Looks like people have been skipping the formatter cause a bunch of pages were committed too 👀 🙅🏻‍♀️

@eshaben eshaben requested a review from a team as a code owner February 13, 2025 03:57
@eshaben eshaben requested a review from nhussein11 February 13, 2025 03:57
Copy link
Collaborator

@nhussein11 nhussein11 left a comment

Choose a reason for hiding this comment

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

Looks so much better, thank you for putting this in a better shape!!

develop/smart-contracts/json-rpc-apis.md Outdated Show resolved Hide resolved
develop/smart-contracts/json-rpc-apis.md Outdated Show resolved Hide resolved
develop/smart-contracts/json-rpc-apis.md Outdated Show resolved Hide resolved
Co-authored-by: Nicolás Hussein <[email protected]>
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.

2 participants