-
Notifications
You must be signed in to change notification settings - Fork 1
chore: change to mdx #5
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
Conversation
bomanaps
commented
Jul 2, 2025
|
This is still a work in progress am not comfortable with having the style inside ethsimulate .mdx itself still working around it but not sure how @acolytec3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would maybe move this into docs /reference under the hood the references will be copied to /docs inside of source which I believe should allow the components to be resolved. This will keep the source code clean where things that relate to docs are logically grouped together.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/reference/components/**.*
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just left a few comments
| # eth_simulate | ||
| This document contains some extra information that couldn't be fit to the specification document directly. | ||
|
|
||
| ## Default block values | ||
| Unlike `eth_call`, `eth_simulateV1`'s calls are conducted inside blocks. We don't require user to define all the fields of the blocks so here are the defaults that are assumed for blocks parameters: | ||
|
|
||
| | parameter name | default value | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assumed originally that this was just a typo that caused the table to not render properly. Is there a bug, that causes the markdown to not render?
I only ask to know if the intent is to have a better looking table or if the intent is to avoid a rendering bug. Better looking table, which is all good as well, just wanted to confirm the md table render works, which might be easier to maintain or work as a guide for people committing to the repo in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried that and I was unable to make it render properly if there is a way you can please give it a shot
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My preference would be to remove the styled table stuff and replace with adding
mdxOptions: {
remarkPlugins: [remarkGfm],
},
to the gatsby-plugin-mdx section of gatsby-config.
If you update this PR to allow commits from maintainers, I'll push a commit with these changes to it or else you can do so. You also need to do npm i -D remark-gfm to add the additional plugin.
it's checked if not I can as well close this, the edit is not looking good |
|
I'm not sure why I can't push commits to this even with the setting ticked. That said, I'll pull in your namespace changes on a commit to my PR. Thanks for cleaning this up! |
could it be because I did this git remote add acolytec3 https://github.com/acolytec3/execution-apis.git |
|
Have pulled the relevant commits from this PR into |