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

docs: redraft JS console page #24974

Merged
merged 7 commits into from Jun 1, 2022
Merged

Conversation

jmcook1186
Copy link
Contributor

redrafts JS console page.


If you need log information, start with:
{% include note.html content="The web3.js version that comes bundled with Geth is not up to date with the official Web3.js documentation. There are several Web3.js libraries that are not available in the Geth Javascript Console. There are also administrative APIs included in the Geth console that are not documented in the Web3.jc documentation. The full list of libraries available in the Geth console is available on the [JSON-RPC API page](/docs/_rpc/server)" %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there no alternative way to includes notes like these? I would prefer not to mix markup with text, as much as possible.

I think I'd prefer just having the note as plain text rather than in such a tag. But that's just my 5c

Copy link
Contributor

Choose a reason for hiding this comment

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

This is the only way I found to add an eye-catching note in jekyll. I can look to see if there are alternative ways of doing it but don't think

Copy link
Contributor Author

Choose a reason for hiding this comment

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

afaik the only pure markdown options available are backticks, bold/italic text or quote blocks. Only the quote block is really viable in my opinion but none are really sufficiently eye-catching.

example quote block

@s1na
Copy link
Contributor

s1na commented May 30, 2022

We also have the js command that's not documented anywhere I believe. Can you please add something short there?

@s1na
Copy link
Contributor

s1na commented May 31, 2022

Let's wait and see what people think about dropping the JS command #25000

Copy link
Contributor

@s1na s1na left a comment

Choose a reason for hiding this comment

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

LGTM

@s1na s1na merged commit b24f4ce into ethereum:gh-pages Jun 1, 2022
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.

None yet

3 participants