Skip to content

docs: sync Docusaurus site to main#21013

Draft
bloxster wants to merge 8 commits intomainfrom
docs/sync-to-main
Draft

docs: sync Docusaurus site to main#21013
bloxster wants to merge 8 commits intomainfrom
docs/sync-to-main

Conversation

@bloxster
Copy link
Copy Markdown
Collaborator

@bloxster bloxster commented May 6, 2026 •
edited
Loading

Summary

Brings the full `docs/site/` Docusaurus tree into `main`, incorporating all documentation improvements developed against `release/3.4`.

Scope: `docs/site/**` + root `llms.txt` / `llms-full.txt` + removal of superseded `docs/gitbook/` and `docs/gitbook-help/`. No changes to Go, proto, or any non-docs source files.

Included sub-PRs

PR What
#20883 Docusaurus v3 migration — full `docs/site/` scaffold, MDX content, help-center, GitHub Actions deploy workflow, custom theme/swizzled components
#20991 Self-hosted fonts — remove Google Fonts/CDN; `@font-face` for Montserrat ExtraBold + Nunito Sans; woff2 files in `static/fonts/`
#20978 SEO, mobile footer, OG image — meta tags, canonical URLs, Open Graph image for all pages
#20997 Remove Quantify font — non-commercial license; navbar/footer brand → Montserrat 800
#21000 LLM-friendly content export — `generate-llms.py` MDX→Markdown; `static/llms.txt` + `static/llms-full.txt`; root `llms.txt` updated from deleted gitbook refs

Additional changes

  • Remove `docs/gitbook/` and `docs/gitbook-help/` — already removed on `release/3.4`; brings `main` to parity
  • `SidebarsConfig` import moved from `@docusaurus/types` → `@docusaurus/plugin-content-docs` (type relocated in this Docusaurus version)

Copilot review fixes (all 9 comments addressed)

File Fix
`category.json` "a Ethereum" → "an Ethereum"
`how-to-run-a-polygon-node.md` URL/word concatenation bug; "tesnet" → "testnet"
`shutter-network.mdx` "reby following" → "by following"
`external-consensus-client-as-validator.md` "Lighhouse" → "Lighthouse"; added missing `\` line continuation
`versioned/sync-modes.md` "three prune modes" → "four prune modes"; updated frontmatter description
`contributing.md` Go 1.24+ → Go 1.25+ (matches `go.mod`)
`README.md` Removed reference to `.github/workflows/docs-deploy.yml` (not present on `main`)

Test plan

  • Verify `docs/site/` builds: `cd docs/site && npm install && npm run build`
  • Confirm `llms.txt` links resolve to live docs.erigon.tech URLs
  • Confirm no Google Fonts or CDN font requests in built site
  • Verify Quantify font is absent from all CSS/HTML output
  • Review GitHub Actions deploy workflow triggers correctly on merge

🤖 Generated with Claude Code

Bloxster and others added 3 commits May 6, 2026 15:00
@claude
docs: sync Docusaurus site to main (self-hosted fonts, SEO, llms.txt)
249ba7c 
Brings the full docs/site Docusaurus tree into main, incorporating all
improvements made against release/3.4:

**Docusaurus migration (PR #20883)**
- Full docs/site scaffold: Docusaurus v3, MDX content, help-center,
  GitHub Actions deploy workflow, custom theme/swizzled components

**Self-hosted fonts (PR #20991)**
- Remove Google Fonts and CDN font imports
- @font-face declarations for Montserrat ExtraBold, Nunito Sans 400/700/800
- woff2 files in docs/site/static/fonts/ — no external font requests

**SEO, mobile footer, OG image (PR #20978)**
- Meta tags, canonical URLs, Open Graph image for all pages
- Mobile footer layout fix

**Remove Quantify font (PR #20997)**
- Quantify.woff2 deleted (non-commercial license, wrong usage scope)
- navbar title and footer brand → Montserrat 800

**LLM-friendly content export (PR #21000)**
- docs/site/scripts/generate-llms.py: stdlib-only MDX-to-markdown exporter
- docs/site/static/llms.txt + llms-full.txt served at docs.erigon.tech
- Root llms.txt / llms-full.txt updated (was pointing at deleted gitbook/)

**Sidebar type fix**
- SidebarsConfig import moved from @docusaurus/types to
  @docusaurus/plugin-content-docs (type relocated in this Docusaurus version)

Scope: docs/site/** only + root llms.txt / llms-full.txt.
No changes to Go, proto, or any non-docs source files.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Merge remote-tracking branch 'origin/main' into docs/sync-to-main
6aa005c
@claude
docs: remove docs/gitbook and docs/gitbook-help
ba40a2b 
Already removed on release/3.4. Brings main to parity — docs/site/
is the canonical documentation source going forward.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@bloxster bloxster requested a review from Copilot May 6, 2026 13:39
Copilot AI reviewed May 6, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR syncs the Erigon documentation on main to match the Docusaurus-based docs tree developed on release/3.4, including versioned docs (v3.3), a help center section, site assets/config, and removal of the legacy GitBook docs.

Changes:

  • Adds Docusaurus site scaffolding/config under docs/site/ (sidebars, TypeScript config, theme overrides, static assets).
  • Introduces versioned documentation structure for v3.3 (versions.json, versioned_docs/, versioned_sidebars/).
  • Removes superseded GitBook documentation trees (docs/gitbook/, docs/gitbook-help/).

Reviewed changes

Copilot reviewed 205 out of 254 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
docs/site/versions.json Adds Docusaurus versions manifest (v3.3).
docs/site/versioned_sidebars/version-v3.3-sidebars.json Adds autogenerated sidebar for v3.3 docs.
docs/site/versioned_docs/version-v3.3/staking/shutter-network.md v3.3 staking doc cleanup/migration from GitBook markup.
docs/site/versioned_docs/version-v3.3/staking/index.md Adds v3.3 staking landing page (cards layout).
docs/site/versioned_docs/version-v3.3/staking/external-consensus-client-as-validator.md v3.3 external-CL staking doc migration tweaks.
docs/site/versioned_docs/version-v3.3/staking/caplin.md v3.3 Caplin staking doc migration tweaks.
docs/site/versioned_docs/version-v3.3/staking/category.json Adds staking section category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/web3.md Adds v3.3 RPC namespace doc (web3).
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/txpool.md Adds v3.3 RPC namespace doc (txpool).
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/ots.md Migrates v3.3 ots doc away from GitBook embeds.
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/net.md Adds v3.3 RPC namespace doc (net).
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/internal.md Adds v3.3 RPC namespace doc (internal).
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/eth.md Adds v3.3 RPC namespace doc (eth).
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/engine.md Adds v3.3 Engine API doc.
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/debug.md Adds v3.3 debug namespace doc.
docs/site/versioned_docs/version-v3.3/interacting-with-erigon/category.json Adds interacting-with-erigon category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/get-started/why-using-erigon.md Updates v3.3 Get Started page frontmatter/formatting.
docs/site/versioned_docs/version-v3.3/get-started/installation/upgrading.md Adds v3.3 upgrading page content.
docs/site/versioned_docs/version-v3.3/get-started/installation/category.json Adds installation category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/get-started/hardware-requirements.md Adds v3.3 hardware requirements page.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/index.md Adds v3.3 easy-nodes landing page (cards layout).
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md Adds v3.3 Ethereum easy-node guide.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-an-ethereum-node/ethereum-with-an-external-cl.md Adds v3.3 Ethereum external-CL guide.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-an-ethereum-node/category.json Adds category metadata for v3.3 Ethereum easy-node section.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-a-polygon-node.md Updates v3.3 Polygon easy-node guide formatting/links.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/index.md Updates v3.3 Gnosis easy-node guide formatting/links.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/gnosis-with-an-external-cl.md Adds v3.3 Gnosis external-CL guide.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/category.json Adds category metadata for v3.3 Gnosis easy-node section.
docs/site/versioned_docs/version-v3.3/get-started/easy-nodes/category.json Adds easy-nodes category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/get-started/category.json Adds get-started category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/fundamentals/web3-wallet.md Adds v3.3 web3-wallet page.
docs/site/versioned_docs/version-v3.3/fundamentals/tls-authentication.md Updates v3.3 TLS auth page links/admonitions.
docs/site/versioned_docs/version-v3.3/fundamentals/sync-modes.md Adds v3.3 sync-modes page.
docs/site/versioned_docs/version-v3.3/fundamentals/supported-networks.md Adds v3.3 supported-networks page.
docs/site/versioned_docs/version-v3.3/fundamentals/security.md Adds v3.3 security page.
docs/site/versioned_docs/version-v3.3/fundamentals/performance-tricks.md Adds v3.3 performance-tricks page.
docs/site/versioned_docs/version-v3.3/fundamentals/otterscan.md Updates v3.3 Otterscan page formatting.
docs/site/versioned_docs/version-v3.3/fundamentals/optimizing-storage.md Adds v3.3 optimizing-storage page.
docs/site/versioned_docs/version-v3.3/fundamentals/modules/sentry.md Updates v3.3 sentry module page frontmatter.
docs/site/versioned_docs/version-v3.3/fundamentals/modules/index.md Updates v3.3 modules landing content/admonitions.
docs/site/versioned_docs/version-v3.3/fundamentals/modules/downloader.md Updates v3.3 downloader module page content/flags listing.
docs/site/versioned_docs/version-v3.3/fundamentals/modules/category.json Adds modules category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/fundamentals/logs.md Adds v3.3 logs page.
docs/site/versioned_docs/version-v3.3/fundamentals/layer-2-networks.md Updates v3.3 L2 networks page frontmatter.
docs/site/versioned_docs/version-v3.3/fundamentals/jwt.md Adds v3.3 JWT page.
docs/site/versioned_docs/version-v3.3/fundamentals/docker-compose.md Updates v3.3 docker-compose page link.
docs/site/versioned_docs/version-v3.3/fundamentals/default-ports.md Adds v3.3 default-ports page.
docs/site/versioned_docs/version-v3.3/fundamentals/creating-a-dashboard.md Adds v3.3 monitoring dashboard page.
docs/site/versioned_docs/version-v3.3/fundamentals/configuring-erigon/category.json Adds CLI reference category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/fundamentals/caplin.md Adds v3.3 Caplin fundamentals page.
docs/site/versioned_docs/version-v3.3/fundamentals/category.json Adds fundamentals category metadata (v3.3).
docs/site/versioned_docs/version-v3.3/about/license.md Adds v3.3 license page.
docs/site/versioned_docs/version-v3.3/about/index.mdx Adds v3.3 about landing page.
docs/site/versioned_docs/version-v3.3/about/disclaimer.md Adds v3.3 disclaimer page.
docs/site/versioned_docs/version-v3.3/about/contributing.md Adds v3.3 contributing page.
docs/site/versioned_docs/version-v3.3/about/category.json Adds about category metadata (v3.3).
docs/site/tsconfig.json Adds TS config for IDE/typecheck support.
docs/site/static/robots.txt Adds robots.txt and sitemap pointer.
docs/site/static/img/shutter.svg Adds shutter icon asset.
docs/site/static/img/pol.svg Adds Polygon icon asset.
docs/site/static/img/gno.svg Adds Gnosis icon asset.
docs/site/static/img/eth.svg Adds Ethereum icon asset.
docs/site/static/CNAME Sets custom domain for Pages deploy.
docs/site/static/.nojekyll Ensures GitHub Pages serves files without Jekyll processing.
docs/site/src/theme/NotFound/index.tsx Adds custom 404 page wrapper.
docs/site/src/theme/NotFound/Content/index.tsx Adds custom 404 content/cards.
docs/site/src/remark/version-replace.js Adds remark plugin to replace {ERIGON_VERSION} tokens.
docs/site/src/components/Version.tsx Adds component to render latest version from site config.
docs/site/sidebars.ts Adds primary docs sidebar config (new SidebarsConfig import).
docs/site/sidebars-help-center.ts Adds help-center sidebar config.
docs/site/README.md Adds site-level dev/build/deploy instructions.
docs/site/package.json Adds Docusaurus/React/TS dependencies and scripts.
docs/site/help-center/index.mdx Adds Help Center landing page.
docs/site/help-center/common-errors-and-solutions.md Adds help-center “Common Errors” content.
docs/site/docs/staking/shutter-network.mdx Adds current staking Shutter Network guide.
docs/site/docs/staking/index.mdx Adds current staking landing page.
docs/site/docs/staking/external-consensus-client-as-validator.md Adds current external-CL validator guide.
docs/site/docs/staking/caplin.md Adds current Caplin staking guide.
docs/site/docs/staking/category.json Adds staking category metadata (current docs).
docs/site/docs/interacting-with-erigon/web3.md Updates web3 namespace doc frontmatter/links.
docs/site/docs/interacting-with-erigon/txpool.md Updates txpool doc frontmatter/formatting.
docs/site/docs/interacting-with-erigon/parity.md Updates parity doc frontmatter/admonitions.
docs/site/docs/interacting-with-erigon/overlay.md Updates overlay doc frontmatter/admonitions.
docs/site/docs/interacting-with-erigon/ots.md Adds ots doc frontmatter.
docs/site/docs/interacting-with-erigon/net.md Updates net doc frontmatter/links.
docs/site/docs/interacting-with-erigon/internal.md Updates internal doc frontmatter/formatting.
docs/site/docs/interacting-with-erigon/index.md Updates RPC service overview and internal links.
docs/site/docs/interacting-with-erigon/grpc.md Updates gRPC doc frontmatter/formatting.
docs/site/docs/interacting-with-erigon/graphql.md Updates GraphQL doc frontmatter/removes embed.
docs/site/docs/interacting-with-erigon/eth.md Updates eth doc frontmatter/links/admonitions.
docs/site/docs/interacting-with-erigon/engine.md Updates engine doc frontmatter/links.
docs/site/docs/interacting-with-erigon/admin.md Updates admin doc frontmatter/formatting.
docs/site/docs/interacting-with-erigon/category.json Adds interacting-with-erigon category metadata (current docs).
docs/site/docs/get-started/installation/upgrading.md Updates upgrading doc frontmatter/anchors/admonitions.
docs/site/docs/get-started/installation/category.json Adds installation category metadata (current docs).
docs/site/docs/get-started/hardware-requirements.mdx Adds current hardware requirements (Tabs-based).
docs/site/docs/get-started/easy-nodes/index.mdx Adds current easy-nodes landing page.
docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md Adds current Ethereum easy-node guide.
docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/ethereum-with-an-external-cl.mdx Adds current Ethereum external-CL guide (Tabs).
docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/category.json Adds category metadata for Ethereum easy-node section.
docs/site/docs/get-started/easy-nodes/how-to-run-a-polygon-node.md Adds current Polygon easy-node guide.
docs/site/docs/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/index.md Adds current Gnosis easy-node guide.
docs/site/docs/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/gnosis-with-an-external-cl.md Updates Gnosis external-CL doc frontmatter/links.
docs/site/docs/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/category.json Adds category metadata for Gnosis easy-node section.
docs/site/docs/get-started/easy-nodes/category.json Adds easy-nodes category metadata (current docs).
docs/site/docs/get-started/category.json Adds get-started category metadata (current docs).
docs/site/docs/fundamentals/web3-wallet.md Updates wallet doc frontmatter/links.
docs/site/docs/fundamentals/sync-modes.md Updates sync-modes doc frontmatter/content.
docs/site/docs/fundamentals/supported-networks.md Updates supported-networks doc frontmatter/admonitions.
docs/site/docs/fundamentals/security.md Updates security doc frontmatter/table content.
docs/site/docs/fundamentals/performance-tricks.md Updates performance-tricks doc frontmatter.
docs/site/docs/fundamentals/otterscan.md Adds Otterscan doc with updated wording.
docs/site/docs/fundamentals/optimizing-storage.md Updates optimizing-storage structure (stepper removal).
docs/site/docs/fundamentals/multiple-instances.md Updates multiple-instances doc admonitions/snippets.
docs/site/docs/fundamentals/modules/txpool.md Updates module links/frontmatter.
docs/site/docs/fundamentals/modules/index.mdx Adds modules landing page (cards layout).
docs/site/docs/fundamentals/modules/category.json Adds modules category metadata (current docs).
docs/site/docs/fundamentals/logs.md Updates logs doc frontmatter and removes permissions section.
docs/site/docs/fundamentals/layer-2-networks.md Adds L2 networks doc content.
docs/site/docs/fundamentals/jwt.md Updates JWT doc frontmatter/admonition syntax.
docs/site/docs/fundamentals/default-ports.md Updates default ports doc frontmatter/table entries.
docs/site/docs/fundamentals/creating-a-dashboard.md Updates dashboard doc frontmatter/formatting.
docs/site/docs/fundamentals/configuring-erigon/nat.md Updates NAT doc frontmatter.
docs/site/docs/fundamentals/configuring-erigon/category.json Adds CLI reference category metadata (current docs).
docs/site/docs/fundamentals/caplin.md Updates Caplin doc frontmatter/link fixes.
docs/site/docs/fundamentals/category.json Adds fundamentals category metadata (current docs).
docs/site/docs/about/license.md Updates license page frontmatter/copyright line.
docs/site/docs/about/index.mdx Adds about landing page (cards layout).
docs/site/docs/about/disclaimer.md Updates disclaimer doc frontmatter.
docs/site/docs/about/contributing.md Adds contributing guidelines for code + docs.
docs/site/docs/about/category.json Adds about category metadata (current docs).
docs/site/.gitignore Adds standard Node/Docusaurus ignores.
docs/gitbook/src/SUMMARY.md Removes legacy GitBook SUMMARY.
docs/gitbook/src/staking/README.md Removes legacy GitBook staking placeholder.
docs/gitbook/src/README.md Removes legacy GitBook introduction page.
docs/gitbook/src/llms.txt Removes legacy GitBook llms export.
docs/gitbook/src/get-started/hardware-requirements.md Removes legacy GitBook hardware requirements.
docs/gitbook/src/get-started/easy-nodes/README.md Removes legacy GitBook easy-nodes landing.
docs/gitbook/src/fundamentals/README.md Removes legacy GitBook fundamentals placeholder.
docs/gitbook/src/about/README.md Removes legacy GitBook about placeholder.
docs/gitbook/src/about/reachus.md Removes legacy GitBook contact page.
docs/gitbook/src/about/how-to-reach-us.md Removes legacy GitBook “how to reach us”.
docs/gitbook/src/about/donate.md Removes legacy GitBook donate page.
docs/gitbook/src/about/contributing.md Removes legacy GitBook contributing page.
docs/gitbook/src/.gitbook/vars.yaml Removes legacy GitBook vars.
docs/gitbook/src/.gitbook/includes/warning-admin_-and-debug_-....md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/replace-less-than-new_version_tag-greater-than-w....md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/press-ctrl+c-in-the-termina....md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/git-fetch-tags.md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/git-clone-https-github.co....md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/git-checkout-version.md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/docker-pull-erigontech-erig....md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/api-documentation.md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/api-documentation-3.md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/api-documentation-2.md Removes legacy GitBook include.
docs/gitbook/src/.gitbook/includes/api-documentation (1).md Removes legacy GitBook include.
docs/gitbook/README.md Removes legacy GitBook build instructions.
docs/gitbook/LICENSE.txt Removes legacy GitBook license file.
docs/gitbook/book.toml Removes legacy mdBook config.
docs/gitbook/.gitignore Removes legacy GitBook ignore.
docs/gitbook-help/SUMMARY.md Removes legacy GitBook Help Center SUMMARY.
docs/gitbook-help/README.md Removes legacy GitBook Help Center landing.
docs/gitbook-help/common-errors-and-solutions.md Removes legacy GitBook help-center content page.
Comments suppressed due to low confidence (5)

docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md:8

  • The page title uses incorrect grammar: "How to run a Ethereum node" should be "How to run an Ethereum node" (both in the H1 and anywhere else this phrasing is reused).
    docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md:71
  • This Ethereum node guide’s "Flag explanation" section is describing Gnosis/Chiado (and later mentions running a Gnosis node). It should match the actual docker-compose example above (Ethereum mainnet) and reference the Ethereum-relevant flags/links instead.
    docs/site/docs/fundamentals/sync-modes.md:17
  • The intro says "three prune modes" but the table lists four (full, minimal, blocks, archive). Update the wording to match the documented set.
    docs/site/versioned_docs/version-v3.3/fundamentals/modules/downloader.md:75
  • --downloader.disable.ipv4 is documented as "Turns off ipv6" here, but the flag name indicates IPv4 and the code flag description is "Turns off ipv4 for the downloader". Please fix this line to avoid misconfiguration.
    docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md:36
  • In the docker-compose YAML, command: uses the exec-form (array of args), so quotes are not stripped by a shell. Using --http.addr="0.0.0.0" will pass the quotes through and can break address parsing. Prefer --http.addr=0.0.0.0 in these compose examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/_category_.json
Comment thread docs/site/docs/get-started/easy-nodes/how-to-run-a-polygon-node.md Outdated
Comment thread docs/site/docs/staking/shutter-network.mdx
Comment thread docs/site/docs/staking/external-consensus-client-as-validator.md Outdated
Comment thread docs/site/docs/staking/external-consensus-client-as-validator.md
Comment thread docs/site/versioned_docs/version-v3.3/fundamentals/sync-modes.md Outdated
Comment thread docs/site/docs/about/contributing.md Outdated
Comment thread docs/site/README.md Outdated
Comment thread docs/site/docs/about/contributing.md
@claude
docs: fix Copilot review issues on ethereum node guide and sync-modes
40dc9d6 
- how-to-run-an-ethereum-node/index.md: "a Ethereum" → "an Ethereum"
- how-to-run-an-ethereum-node/index.md: remove quoted --http.addr="0.0.0.0"
  (exec-form passes quotes through); use --http.addr=0.0.0.0
- how-to-run-an-ethereum-node/index.md: Flag explanation section was
  describing Gnosis/Chiado flags; corrected to Ethereum mainnet
- sync-modes.md: "three prune modes" → "four prune modes" (full/minimal/
  blocks/archive); updated frontmatter description to match
- versioned_docs/version-v3.3/modules/downloader.md: --downloader.disable.ipv4
  said "Turns off ipv6" — corrected to "ipv4"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@bloxster bloxster mentioned this pull request May 6, 2026
Merged
Bloxster and others added 2 commits May 6, 2026 22:12
@claude
docs: address Copilot review comments on PR #21013
9066676 
- _category_.json: "a Ethereum" → "an Ethereum"
- polygon-node.md: fix URL/word concatenation, fix "tesnet" typo
- shutter-network.mdx: fix "reby" → "by"
- external-consensus-client-as-validator.md: fix "Lighhouse", add missing backslash continuation
- versioned/sync-modes.md: "three prune modes" → "four prune modes", fix description
- contributing.md: Go 1.24+ → Go 1.25+ (matches go.mod)
- README.md: remove reference to non-existent docs-deploy.yml on main

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@bloxster
Merge branch 'main' into docs/sync-to-main
ef5214b
@bloxster bloxster added the docs label May 7, 2026
bloxster pushed a commit that referenced this pull request May 7, 2026
@claude
ci: guard docs-site build against missing docs/site directory
1d12fb5 
docs/site/ does not exist on main until PR #21013 merges. Without a
guard, the docs-site job fires for merge_group events (docs_site=true
for all non-PR events) and fails on npm ci in a missing directory,
blocking this PR from merging itself.

Add a presence check on docs/site/package.json; steps are skipped
(job passes) when the directory is absent. Also:
- node-version '20' -> '20.x' (standard semver range notation)
- drop secrets:inherit from docs-site job (build needs no secrets)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
bloxster and others added 2 commits May 7, 2026 18:53
@bloxster
Merge branch 'main' into docs/sync-to-main
039e22d
docs(llms): refresh from latest #21000 — preserve placeholders, synth…
789606e 
…esize landings, regenerate

Brings #21013 in line with the latest state of #21000:

- generate-llms.py: preserve {ERIGON_VERSION}/identifier braces in prose +
  table cells; multi-line JSX-expr block stripping; landing-page synthesis
  (## Sections + bullets) for card-grid index pages; singleton section
  header drop; nested _category_.json honored via ancestor_positions;
  hardened parse_frontmatter (skip indented continuations, _safe_int);
  tightened first_description (only skip JSX-leak-shaped lines);
  --check flag for drift detection; argparse main; Python 3.8+.

- test_generate_llms.py: 25-test unittest suite covering placeholder
  preservation, fence transparency, JSX/MDX stripping, frontmatter
  parsing, and landing-page synthesis.

- Regenerated llms.txt + llms-full.txt (root + static/) from current
  source, picking up sync-to-main's "four prune modes" / typo / yaml
  exec-form fixes.
bloxster added a commit that referenced this pull request May 8, 2026
@bloxster @claude
[r3.4] docs: May 2026 w19 maintenance — stale flags, broken links, ac…
0cb5369 
…curacy fixes (#21018)

## Summary

Addresses findings from the w19 weekly docs full check against
`release/3.4`.

## Changes

### Broken GitHub blob links fixed — `versioned_docs/version-v3.3/`

| File | Fix |
|------|-----|
| `interacting-with-erigon/erigon.md` | `README` → `README.md` |
| `fundamentals/modules/rpc-daemon.md` | `README` → `README.md` (×2) |
| `fundamentals/modules/downloader.md` | `readme` → `readme.md` |

### Content & language fixes

| Category | File | Fix |
|----------|------|-----|
| Semantic | `docs/fundamentals/sync-modes.md` | "three prune modes" →
"four" (full / minimal / blocks / archive); frontmatter updated |
| Semantic | `versioned_docs/version-v3.3/fundamentals/sync-modes.md` |
same |
| Semantic | `docs/about/contributing.md` | "Go 1.24+" → "Go 1.25+"
(matches `go.mod`) |
| Syntax |
`docs/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md` | "a
Ethereum" → "an Ethereum"; flag explanation corrected from Gnosis/Chiado
to Ethereum mainnet; `--http.addr="0.0.0.0"` → `--http.addr=0.0.0.0` |
| Syntax | `docs/.../gnosis-with-an-external-cl.md` (v3.4 + v3.3) | "a
Ethereum" → "an Ethereum" |
| Syntax |
`versioned_docs/version-v3.3/.../how-to-run-an-ethereum-node/index.md` |
"a Ethereum" → "an Ethereum" |
| Syntax | `docs/fundamentals/basic-usage.mdx` (v3.4 + v3.3) | "a
archive" → "an archive"; missing `\` line continuation added |
| Syntax | `docs/staking/external-consensus-client-as-validator.md`
(v3.4 + v3.3) | missing `\` line continuation added |
| Syntax |
`versioned_docs/version-v3.3/fundamentals/multiple-instances.md` |
missing `\` line continuation added |
| Syntax |
`versioned_docs/version-v3.3/fundamentals/modules/downloader.md` |
`--downloader.disable.ipv4` described as "Turns off ipv6" — corrected to
ipv4 |
| Spell | `docs/staking/external-consensus-client-as-validator.md` (v3.4
+ v3.3) | "Lighhouse" → "Lighthouse" |
| Spell | `docs/.../gnosis-with-an-external-cl.md` (v3.4 + v3.3) |
"Lightouse" → "Lighthouse"; "your is syncing" → "your node is syncing" |
| Branding | `versioned_docs/version-v3.3/about/contributing.md` |
"Github" → "GitHub" |
| Accuracy | `docs/fundamentals/basic-usage.mdx` + v3.3,
`docs/get-started/easy-nodes/.../index.md` + v3.3,
`docs/fundamentals/configuring-erigon/index.mdx` + v3.3 |
`--torrent.download.rate` description unified across all 6 files:
correct default (512mb), shared-machine note, and `Inf` option |

After this merges, a follow-up PR will cherry-pick to `main` on top of
#21013.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Bloxster <bloxster@proton.me>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@AskAlexSharov AskAlexSharov Awaiting requested review from AskAlexSharov AskAlexSharov will be requested when the pull request is marked ready for review AskAlexSharov is a code owner

@yperbasis yperbasis Awaiting requested review from yperbasis yperbasis will be requested when the pull request is marked ready for review yperbasis is a code owner

@Giulio2002 Giulio2002 Awaiting requested review from Giulio2002 Giulio2002 will be requested when the pull request is marked ready for review Giulio2002 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bloxster