Skip to content

docs: w25 prose fixes (release/3.4) — casing, leaked editorial note, EL acronym, polygon flag typo - #21840

Merged
AskAlexSharov merged 5 commits into
release/3.4from
docs/prose-fixes-w25-r34
Jun 19, 2026
Merged

docs: w25 prose fixes (release/3.4) — casing, leaked editorial note, EL acronym, polygon flag typo#21840
AskAlexSharov merged 5 commits into
release/3.4from
docs/prose-fixes-w25-r34

Conversation

@bloxster

Copy link
Copy Markdown
Collaborator

Weekly docs maintenance (w25) — prose-quality pass on release/3.4. Doc-only, no code touched.

Changes

  • configuring-erigon/index.mdx — remove a leaked LLM editorial note ("Here is the rewritten and merged Downloader section…") that had ridden into the page (and the generated llms-full.txt).
  • docker-compose.md — "shared between erigon and RPC Daemon" → Erigon (mid-sentence proper noun).
  • tls-authentication.md, installation/index.mdx — "RPC daemon" → RPC Daemon (prose form of the module name).
  • how-to-run-a-polygon-node.md — fix a mashed flag value: --bor.heimdall=https://heimdall-api.polygon.technologyspecifies…polygon.technology (the word "specifies" had been pulled inside the code span).
  • ethereum-with-an-external-cl.mdx — expand ELExecution Layer (EL) on first use.
  • Regenerated llms.txt / llms-full.txt bundles to match.

Verification

  • npm run build (Docusaurus, onBrokenLinks: 'throw') — green.
  • generate-llms.py --check — OK (4 bundles match, 71 pages).
  • Editorial-artifact scan — clean.

🤖 Generated with Claude Code

…lygon flag typo

Weekly maintenance prose pass (release/3.4):
- configuring-erigon: remove leaked LLM editorial note above the Downloader section
- docker-compose: "erigon" -> "Erigon" (mid-sentence proper noun)
- tls-authentication, installation: "RPC daemon" -> "RPC Daemon" (prose form of module name)
- how-to-run-a-polygon-node: fix mashed --bor.heimdall URL ("polygon.technologyspecifies")
- ethereum-with-an-external-cl: expand "EL" -> "Execution Layer (EL)" on first use

Regenerated llms.txt/llms-full.txt bundles. Docusaurus build green.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Doc-only weekly maintenance for the release/3.4 documentation set, focused on cleaning up prose/casing issues, removing a leaked editorial artifact, and fixing a broken Polygon flag example, with regenerated LLM bundles to match.

Changes:

  • Removed an accidentally committed editorial/LLM note from the configuring flags page (and corresponding llms bundles).
  • Standardized module/proper-noun casing (e.g., “RPC Daemon”, “Erigon”) and expanded “Execution Layer (EL)” on first use.
  • Corrected a malformed Polygon Heimdall flag value and regenerated llms-full.txt artifacts.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
llms-full.txt Regenerated combined docs bundle reflecting prose fixes and editorial note removal.
docs/site/static/llms-full.txt Regenerated static docs bundle to match updated docs content.
docs/site/docs/get-started/installation/index.mdx Updated casing for “RPC Daemon” in WSL guidance.
docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/ethereum-with-an-external-cl.mdx Expanded “Execution Layer (EL)” on first use in closing guidance.
docs/site/docs/get-started/easy-nodes/how-to-run-a-polygon-node.md Fixed Heimdall endpoint typo in flag explanation.
docs/site/docs/fundamentals/tls-authentication.md Updated casing to “RPC Daemon” in TLS instructions.
docs/site/docs/fundamentals/docker-compose.md Updated mid-sentence proper noun casing for “Erigon”.
docs/site/docs/fundamentals/configuring-erigon/index.mdx Removed leaked editorial note before the Downloader section.

💡 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-a-polygon-node.md Outdated
Comment thread docs/site/docs/fundamentals/docker-compose.md Outdated
bloxster and others added 3 commits June 16, 2026 10:19
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot Autofix committed two prose fixes (tesnet->testnet, `makefile`->`Makefile`)
to docs source without regenerating the llms.txt/llms-full.txt bundles, breaking
the docs-site `generate-llms.py --check` gate. Regenerate to reconcile.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
yperbasis added a commit that referenced this pull request Jun 17, 2026
These two w25 prose fixes landed on the release/3.4 companion (#21840)
via Copilot Autofix but were missed here, leaving main behind on the
docker-compose page. Port them for dual-commit parity and regenerate the
llms-full.txt bundles.
@AskAlexSharov
AskAlexSharov enabled auto-merge (squash) June 18, 2026 02:13
pull Bot pushed a commit to Dustin4444/erigon that referenced this pull request Jun 18, 2026
… fence tags (erigontech#21841)

Weekly docs maintenance (w25) — prose-quality pass on `main`. Doc-only,
no code touched. Companion to erigontech#21840 (same fixes on `release/3.4`, per
the dual-commit rule), plus two `main`-only fence fixes for pages that
don't exist on `release/3.4`.

### Changes
- **docker-compose.md** — "shared between **erigon** and RPC Daemon" →
**Erigon** (mid-sentence proper noun).
- **tls-authentication.md**, **installation/index.mdx** — "RPC daemon" →
**RPC Daemon** (prose form of the module name).
- **how-to-run-a-polygon-node.md** — fix a mashed flag value:
`--bor.heimdall=https://heimdall-api.polygon.technologyspecifies` →
`…polygon.technology`.
- **ethereum-with-an-external-cl.mdx** — expand **EL** → **Execution
Layer (EL)** on first use.
- **architecture.md**, **database.md** (`main`-only) — tag untyped code
fences as ` ```text ` (Block-STM pipeline diagram, datadir tree).
- Regenerated `llms.txt` / `llms-full.txt` bundles to match.

### Verification
- `npm run build` (Docusaurus, `onBrokenLinks: 'throw'`) — green.
- `generate-llms.py --check` — OK (4 bundles match, 74 pages).
- Editorial-artifact scan — clean.

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

---------

Co-authored-by: Bloxster <gianni.morselli@erigon.tech>
Co-authored-by: Claude Opus 4.8 (1M context) <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>
Co-authored-by: yperbasis <andrey.ashikhmin@gmail.com>
AskAlexSharov pushed a commit that referenced this pull request Jun 19, 2026
…g typo (#21890)

Weekly maintenance prose pass for **release/3.5**, ported from the
release/3.4 pass in #21840.

## Changes
- **docker-compose.md**: `erigon` → `Erigon` (mid-sentence proper noun)
- **tls-authentication.md**: `RPC daemon` → `RPC Daemon` (prose form of
the module name)
- **installation/index.mdx**: `RPC daemon` → `RPC Daemon`
- **how-to-run-a-polygon-node.md**: fix mashed `--bor.heimdall` URL
(`polygon.technologyspecifies` → `polygon.technology`)
- **ethereum-with-an-external-cl.mdx**: expand `EL` → `Execution Layer
(EL)` on first use

Regenerated `llms-full.txt` bundles; `generate-llms.py --check` prints
OK.

## Notes
- The release/3.4 commit that removed a leaked editorial note
(`configuring-erigon`) **does not apply here** — that text is already
absent on release/3.5 (the page was restructured from
`configuring-erigon/index.mdx` to `configuring-erigon.mdx`).
- Pre-push gate passed locally: `pnpm build` green (no broken links /
MDX errors), editorial-artifact scan clean, llms `--check` OK.
- Only `docs/site/` content (plus the generated root `llms-full.txt`
bundle) is touched.

---------

Co-authored-by: Bloxster <gianni.morselli@erigon.tech>
@bloxster

Copy link
Copy Markdown
Collaborator Author

@yperbasis due to the Linux (Ubuntu latest) check not running, this PR must be merged with an admin merge. Alternatively, we can close this since the equivalent issue in 3.5 and the main branch has already been fixed.

@AskAlexSharov
AskAlexSharov merged commit bda6970 into release/3.4 Jun 19, 2026
27 checks passed
@AskAlexSharov
AskAlexSharov deleted the docs/prose-fixes-w25-r34 branch June 19, 2026 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants