Skip to content

Conversation

@Animesh-Parashar
Copy link
Contributor

Wiki PR Checklist

Thank you for contributing to the Protocol Wiki! Before you open a PR, make sure to read information for contributors and take a look at following checklist:

  • Describe your changes
    This PR fixes a broken in-page Markdown link in
    docs/wiki/research/Preconfirmations/BasedSequencingPreconfs.md.
    The "Motivation" section incorrectly linked to a relative path instead of a local anchor, causing Docsify to route to a non-existent page and return a 404. The link has been corrected to use the proper heading anchor.

  • If you are touching an existing piece of content, ask the original creator for review
    This change is a minimal mechanical fix (one-line link correction) and does not alter content meaning or structure.

  • If you need feedback for your content from wider community, share the PR in our Discord
    Not applicable, this PR fixes a technical documentation bug and does not introduce new content.

  • Review changes to ensure there are no typos, see instructions below

Closes #467

@github-actions
Copy link

Hi @Animesh-Parashar,

⚠️ Potential typos found in your pull request:

  • 📄 ./docs/eps/week1.md (line(s) 134):
    1. ❌ resleased
  • 📄 ./docs/eps/schedule.md (line(s) 35):
    1. ❌ Rakita
  • 📄 ./docs/wiki/testing/consensus-spec-tests.md (line(s) 15):
    1. ❌ symlinks
  • 📄 ./docs/wiki/testing/consensus-spec-tests.md (line(s) 23):
    1. ❌ incorect
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 3,5,6,9,15,17,19,29,57,83,99,110,186):
    1. ❌ ectra
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 59,63,65,121,150,152,186,197,199):
    1. ❌ sys
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 152,199):
    1. ❌ asm
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 51,114,140,152,199,237,241):
    1. ❌ eas
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 59,63,65,121,150,152,186,197,199):
    1. ❌ sys
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 152,199):
    1. ❌ asm
  • 📄 ./docs/wiki/pectra-faq.md (line(s) 51,114,140,152,199,237,241):
    1. ❌ eas
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 13):
    1. ❌ orginally
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 29):
    1. ❌ multiaddress
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 31):
    1. ❌ Multiaddress
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 31):
    1. ❌ Multiaddress
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 66):
    1. ❌ negociation
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 75):
    1. ❌ Multiaddrs
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 80):
    1. ❌ proactivily
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 56,82,128,279):
    1. ❌ kad
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 91):
    1. ❌ multihashes
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 91,97,281):
    1. ❌ multihash
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 101):
    1. ❌ Multihash
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 107):
    1. ❌ multibase
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 109):
    1. ❌ establised
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 126):
    1. ❌ Multicast
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 128,131):
    1. ❌ multiaddrs
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 128,131):
    1. ❌ multiaddrs
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 149):
    1. ❌ mututal
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 159):
    1. ❌ rount
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 163):
    1. ❌ Gossibhub
  • 📄 ./docs/wiki/CL/cl-networking.md (line(s) 160,171):
    1. ❌ gossibsub

ℹ️ How to fix this error:

  1. If these are actual typos:

    • Open the files at the specified line numbers and fix them
  2. If these are names or one-off nouns:

    • Wrap them in <name> tags
    • Example: <name>Alex Pereira</name>
    • Use this for people's names or unique terms that appear rarely
  3. If these are valid terms:

    • Add them to wordlist.txt (one word per line)
    • Terms must be plain text without spaces/special chars
    • The list is case-insensitive
  4. If these are code terms:

    • Wrap them in backticks (`) in your markdown

ℹ️ Checking for typos locally

  1. Install aspell for your platform
  2. Navigate to project root and run:
for f in **/*.md ; do echo $f ; aspell --lang=en_US --mode=markdown --home-dir=. --personal=wordlist.txt --ignore-case=true --camel-case --add-sgml-skip nospellcheck list < $f | sort | uniq -c ; done

Learn more about wordlist format

@taxmeifyoucan taxmeifyoucan merged commit 0392669 into eth-protocol-fellows:main Dec 25, 2025
1 of 2 checks passed
@Animesh-Parashar
Copy link
Contributor Author

For clarity: this PR initially changed only a single Markdown file to fix a broken in-page link causing a 404.

The CI failure was triggered by the global spellcheck job. To address the initial failure, I edited wordlist.txt to fix an invalid entry, which caused the spellcheck to re-run against the entire repository. This surfaced a number of pre-existing typos in unrelated Markdown files that were not modified in this PR.

It looks like the spellcheck job runs against all Markdown files in the repository, and is surfacing pre-existing typos in unrelated documents.

For this PR, would you prefer that spellcheck be scoped to changed files only, or should these be handled in a separate cleanup PR?

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.

Broken in-page link causes 404 in BasedSequencingPreconfs.md

2 participants