Skip to content

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

Merged
bloxster merged 1 commit into
mainfrom
docs/cli-reference-cross-links-main
Jun 13, 2026
Merged

docs: cross-link CLI Reference sections to their dedicated pages#21772
bloxster merged 1 commit into
mainfrom
docs/cli-reference-cross-links-main

Conversation

@bloxster

Copy link
Copy Markdown
Collaborator

Main counterpart of #21763 (which added the same cross-links on release/3.5). Now that #21765 (the #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

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

Adds cross-links from the flattened CLI Reference page to the corresponding dedicated documentation pages, and regenerates the LLM artifact outputs so those links are reflected consistently.

Changes:

  • Add one contextual cross-link per CLI Reference section to its dedicated doc page (e.g., Database, Snapshots Management, TxPool, RPC, MCP, Logs, etc.).
  • Add targeted cross-links on specific flags (--authrpc.jwtsecret → JWT docs, --metrics → dashboard docs).
  • Regenerate llms-full.txt artifacts to keep them in sync with the docs content.

Reviewed changes

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

File Description
llms-full.txt Updates the generated LLM artifact to include the new cross-links from the CLI Reference sections/flags.
docs/site/static/llms-full.txt Mirrors the llms-full.txt artifact update for the docs-site static copy.
docs/site/docs/fundamentals/configuring-erigon.mdx Adds cross-links from CLI Reference sections/flags to their dedicated documentation pages.

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

@AskAlexSharov AskAlexSharov added this pull request to the merge queue Jun 13, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Jun 13, 2026
@bloxster bloxster added this pull request to the merge queue Jun 13, 2026
Merged via the queue into main with commit 50a6302 Jun 13, 2026
22 checks passed
@bloxster bloxster deleted the docs/cli-reference-cross-links-main branch June 13, 2026 06:36
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