Skip to content

Edit documentation guide#73

Merged
alexandratran merged 4 commits intomainfrom
update-guide
Nov 26, 2025
Merged

Edit documentation guide#73
alexandratran merged 4 commits intomainfrom
update-guide

Conversation

@alexandratran
Copy link
Contributor

@alexandratran alexandratran commented Nov 26, 2025

Edit documentation guide to ensure links and information are up-to-date.

Preview: https://docs-template-7ozfdszpo-consensys-ddffed67.vercel.app/


Note

Adds Linkspector config and guide, retires the CSpell page in favor of Vale, updates Stylelint and multiple docs (Node 20+, workflows, links), and adds a redirect for the old spell-check path.

  • Docs:
    • Link checking: Add new page docs/contribute/run-link-checker.md for Linkspector; remove docs/configure/spell-check.md; refresh Vale instructions (docs/contribute/run-vale.md).
    • Guides/content:
      • Update formatting guide with a new “Links” section.
      • Update preview to require Node.js 20+.
      • Tweak contribution and review pages (clarify forking/write-access; sidebar positions).
      • Refresh search setup wording (open source/closed source corrections).
      • Update Docusaurus redirects doc link.
      • Expand repository structure/workflows (add links.yml, dependabot.yml, spelling.yml, trivy.yaml descriptions; trim outdated bits).
      • Update index table entries (Besu link/guidelines, add DIN, Linea note).
  • Configs:
    • Add .linkspector.yml with dirs, ignores, and alive status codes.
    • Update .stylelintrc.js (allow display: show, disable color-function-alias-notation).
    • Add Vercel redirect from /configure/spell-check/ to /contribute/run-vale/.

Written by Cursor Bugbot for commit 21ff9f0. This will update automatically on new commits. Configure here.

@vercel
Copy link

vercel bot commented Nov 26, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs-template Ready Ready Preview Comment Nov 26, 2025 2:19am

Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

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

lgtm

@alexandratran alexandratran merged commit 86b4e67 into main Nov 26, 2025
8 of 10 checks passed
@alexandratran alexandratran deleted the update-guide branch November 26, 2025 17:06
m4sterbunny pushed a commit that referenced this pull request Dec 21, 2025
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.

2 participants