Skip to content

docs: cross-link CLI Reference sections to their dedicated pages#21763

Merged
bloxster merged 4 commits into
release/3.5from
docs/cli-reference-cross-links-r35
Jun 12, 2026
Merged

docs: cross-link CLI Reference sections to their dedicated pages#21763
bloxster merged 4 commits into
release/3.5from
docs/cli-reference-cross-links-r35

Conversation

@bloxster

Copy link
Copy Markdown
Collaborator

Follow-up to #21687. Adds one cross-link per section of the CLI Reference (configuring-erigon) to its dedicated page — placed in the section explainer where possible, or on the most relevant flag. One link per target page, no duplicates of the links already present (nat / supported-networks / pruning-modes / eth_getProof).

Explainer links: Database, Snapshots Management, TxPool, Default Ports, Interacting with Erigon (RPC), MCP, Logs, Sentry, Downloader, Caplin, Shutter Network, Docker Compose.
Targeted flag links: JWT (on --authrpc.jwtsecret), Creating a dashboard (on --metrics).

Build passes the onBrokenLinks: 'throw' check; llms.txt / llms-full.txt regenerated.

🤖 Generated with Claude Code

Each section of the CLI Reference now links once to its dedicated page —
in the section explainer where possible, or on the most relevant flag:
Database, Snapshots Management, TxPool, Default Ports, Interacting with
Erigon (RPC), MCP, Logs, Sentry, Downloader, Caplin, Shutter Network,
Docker Compose; JWT (on --authrpc.jwtsecret) and Creating a dashboard
(on --metrics). One link per target, no duplicates of the existing
nat / supported-networks / prune-modes / eth_getProof links.

Regenerate llms bundles. Build passes onBrokenLinks check.

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

This PR improves docs navigation by adding cross-links from each CLI Reference section (Configuring Erigon) to the corresponding dedicated documentation pages, and regenerates the LLM artifact outputs to reflect the updated content.

Changes:

  • Add “See …” cross-links in CLI Reference section explainers (Database, Snapshots, TxPool, Ports, RPC, MCP, Logs, Sentry, Downloader, Caplin, Shutter, Docker).
  • Add targeted cross-links on specific flags (--authrpc.jwtsecret → JWT, --metrics → dashboard creation).
  • Regenerate llms-full.txt artifacts (repo root + docs static copy) to match the updated CLI Reference.

Reviewed changes

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

File Description
llms-full.txt Regenerated LLM artifact including the new cross-links from CLI Reference sections/flags.
docs/site/static/llms-full.txt Regenerated docs-static LLM artifact mirroring the root llms-full.txt updates.
docs/site/docs/fundamentals/configuring-erigon.mdx Adds cross-links from CLI Reference sections/flags to their dedicated docs pages.

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

Comment thread docs/site/docs/fundamentals/configuring-erigon.mdx Outdated
Comment thread llms-full.txt Outdated
Comment thread docs/site/static/llms-full.txt Outdated
bloxster and others added 3 commits June 12, 2026 13:26
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>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@bloxster bloxster merged commit 54cdce0 into release/3.5 Jun 12, 2026
20 checks passed
@bloxster bloxster deleted the docs/cli-reference-cross-links-r35 branch June 12, 2026 16:33
pull Bot pushed a commit to Dustin4444/erigon that referenced this pull request Jun 13, 2026
…gontech#21772)

Main counterpart of erigontech#21763 (which added the same cross-links on
release/3.5). Now that erigontech#21765 (the erigontech#21687 forward-port) has merged, the
flattened CLI Reference page and its link targets exist on `main`, so
this applies cleanly.

Adds one cross-link per section of the **CLI Reference**
(`configuring-erigon`) to its dedicated page — in the section explainer
where possible, or on the most relevant flag. One link per target, no
duplicates of the links already present (nat / supported-networks /
pruning-modes / eth_getProof).

**Explainer links:** Database, Snapshots Management, TxPool, Default
Ports, Interacting with Erigon (RPC), MCP, Logs, Sentry, Downloader,
Caplin, Shutter Network, Docker Compose.
**Targeted flag links:** JWT (on `--authrpc.jwtsecret`), Creating a
dashboard (on `--metrics`).

Build passes the `onBrokenLinks: 'throw'` check; `llms.txt` /
`llms-full.txt` regenerated.

🤖 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>
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.

3 participants