nethermindeth / docs

Nethermind documentation

Nethermind docs

Built with Docusaurus.

Running locally

Requires Node.js v18 or later.

If running the first time, install dependencies:

npm i

Run the docs as follows:

npm run start

docs's Issues

Update Getting Started page

These sections of Getting Started page of the docs need to be updated:

• Launching Nethermind
• Explaining Nethermind Logs

Note:
This unexisting page is refered in the penultimate paragraph

Documention not available in other languages

Documention need to available in other major language
Like Chinese, Spanish and french for not English speakers.

Docs don't use available space and it makes tables hard to read.

Current behavior:

Desired Behavior:

The above is just a couple of CSS changes that make the page fill available space. You could improve it further by making the columns not all the same width, but that is a problem specific to this page and a much bigger change so for now I'm just lobbying for the very simple removal of hard-coded widths.

For reference, here is the getting started page with the same settings:

Note that it is still quite pleasing to read, and I argue better than the current version.

I tried looking for CSS files in this repository but couldn't find them, so I'm not actually sure how/where to make this change.

Image not loading on CLI page

Hey. While going through your docs I noticed an image (Nethermind.Cli operations) is not loading: https://docs.nethermind.io/nethermind/nethermind-utilities/cli

Typo in "How to setup a Nethermind only Spaceneth based chain"?

From ethereum-client/private-networks/how-to-setup-a-nethermind-only-spaceneth-based-chain.md:

• download chainspec file with clique engine and place it in genesis folder.

Should be spaceneth engine?

Log Documentation Out of Date

This page https://docs.nethermind.io/nethermind/first-steps-with-nethermind/getting-started is woefully out of date. It hasn't been updated in over a year and the logs have changed dramatically. It is an important page for a node operator to understand what is happening and an update would be much appreciated!

[FEATURE REQUEST] Add security policy

Is your feature request related to a problem? Please describe.
There appears to be no way to understand what to do if there is a security bug

Describe the solution you'd like
Add a policy to the security tab

Describe alternatives you've considered
Can be in the readme but the security tab is probably best

Additional context
Happy to help with a pull request if given some guidance

Updating image preview

The image used for the preview should be this one:

Link on Download Resource page doesn't redirect to downloads page

There are two Welcome to Nethermind link on https://docs.nethermind.io/nethermind/ethereum-client/download-sources.
Instead there should be one that leads to the downloads page.