Summary
A few pages use the product name with incorrect casing, and one page uses deprecated Ethereum terminology. Fix them, and add a check so they do not reappear.
This is a small, self-contained change and a good first contribution.
Product name casing
The correct spelling is Web3Signer, with a capital S. The variants web3signer, Web3signer, and web3Signer should not appear in prose. They are fine inside code, URLs, and direct quotations.
Two files use Web3signer:
reference/security-disclosure.md, line 2, in the frontmatter descriptionconcepts/slashing-protection.md, line 26, twice in the same sentence
The security disclosure page is one of the first pages a security researcher opens, so a misspelling of the product name in its own metadata is worth fixing.
Deprecated terminology
Use consensus layer rather than "Ethereum 2.0".
One line needs changing:
get-started/key-best-practices.md, line 8: "Web3Signer manages validator keys for Ethereum 2.0 staking."
Please leave the other occurrences alone. Several pages mention "Ethereum 2.0" specifically to explain that it is the former name of the consensus layer, for example in index.md and reference/cli/subcommands.md. Those are correct and useful, and should stay.
Minor consistency fix
reference/security-disclosure.md, line 16, uses a curly apostrophe in "don't". The rest of the documentation uses straight quotes.
Apply changes in both places
This repository is versioned, and the live site serves the stable version from versioned_docs/, not from docs/.
Every fix above needs to be made twice:
- in
docs/ (the development version)
- in
versioned_docs/version-26.7.0/ (the stable version served at the site root)
Summary
A few pages use the product name with incorrect casing, and one page uses deprecated Ethereum terminology. Fix them, and add a check so they do not reappear.
This is a small, self-contained change and a good first contribution.
Product name casing
The correct spelling is Web3Signer, with a capital S. The variants
web3signer,Web3signer, andweb3Signershould not appear in prose. They are fine inside code, URLs, and direct quotations.Two files use
Web3signer:reference/security-disclosure.md, line 2, in the frontmatterdescriptionconcepts/slashing-protection.md, line 26, twice in the same sentenceThe security disclosure page is one of the first pages a security researcher opens, so a misspelling of the product name in its own metadata is worth fixing.
Deprecated terminology
Use consensus layer rather than "Ethereum 2.0".
One line needs changing:
get-started/key-best-practices.md, line 8: "Web3Signer manages validator keys for Ethereum 2.0 staking."Please leave the other occurrences alone. Several pages mention "Ethereum 2.0" specifically to explain that it is the former name of the consensus layer, for example in
index.mdandreference/cli/subcommands.md. Those are correct and useful, and should stay.Minor consistency fix
reference/security-disclosure.md, line 16, uses a curly apostrophe in "don't". The rest of the documentation uses straight quotes.Apply changes in both places
This repository is versioned, and the live site serves the stable version from
versioned_docs/, not fromdocs/.Every fix above needs to be made twice:
docs/(the development version)versioned_docs/version-26.7.0/(the stable version served at the site root)