Skip to content

[r3.6] docs(site): stop presenting Polygon as a supported target - #23625

Merged
bloxster merged 6 commits into
release/3.6from
docs/polygon-framing-r36
Aug 27, 2026
Merged

bloxster merged 6 commits into
release/3.6from
docs/polygon-framing-r36

Conversation

@bloxster

Copy link
Copy Markdown
Collaborator

Polygon has not been officially supported since 3.1, but the 3.6 docs still offer it as a choice. This scopes it without removing the reference material, because the bor code does still ship in this branch — the bor-mainnet and amoy tags are selectable, the bor namespace is servable, and all seven --bor.* / --polygon.* flags are registered in erigon --help.

Presented as a choice, now not:

  • Polygon sat in the Mainnets table beside Ethereum and Gnosis, with its caveat a footnote 25 lines below. It moves to its own "Polygon (not supported)" section, which absorbs the Amoy tag.
  • Three cards advertised a one-command Polygon easy-node setup. That guide was removed from this branch and /get-started/easy-nodes/how-to-run-a-polygon-node is now a redirect, so the cards promised something that no longer exists.
  • The FAQ answered "supports networks such as Gnosis and Polygon". That string is in faqSchema, so it ships as JSON-LD.

Kept, and scoped instead: the bor_ method reference, the Polygon gRPC services, and the seven flags — all accurate for 3.6. The flags move under a "Legacy Polygon flags" heading so the CLI reference stays complete against erigon --help, and the bor namespace entry and the gRPC section point at Supported Networks.

Two fixes along the way: the help center cited --bor.heimdall.url, which is not a flag (the real one is --bor.heimdall); that example now uses --externalcl. The Layer 2 page description advertised "Polygon PoS, Bor" on a page whose body is entirely about running an op-node.

main already dropped all of this along with the code (#23492, #23497), so nothing here forward-ports.

llms.txt / llms-full.txt regenerated; --check and npm run build pass.

Polygon has not been officially supported since 3.1, but the docs still
offered it as a choice: a Polygon row in the Mainnets table, an Amoy
testnet section, and three cards advertising a Polygon easy-node guide
that was removed from this branch and is now a redirect.

The bor code still ships in 3.6 — the chain tags are selectable, the
namespace is servable and the flags are registered — so the reference
material stays. It is scoped instead: Polygon moves into its own
"not supported" section, the bor flags get their own heading, and the
bor namespace and Polygon gRPC services carry a pointer to it.

Also fixes --bor.heimdall.url in the help center, which is not a flag,
and the Layer 2 page description, which advertised Polygon PoS on a
page about running an op-node.

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

Updates the Erigon 3.6 documentation site to stop presenting Polygon as an officially supported target while keeping Bor/Polygon reference material that still exists in the release branch (RPC namespace, gRPC services, and CLI flags).

Changes:

  • Moves Polygon out of the “Mainnets/Testnets” supported-network listings into an explicit “Polygon (not supported)” section and updates related page descriptions.
  • Removes/adjusts “Easy Nodes” and other site copy that advertised Polygon as a one-command supported setup.
  • Scopes remaining Bor/Polygon references with warnings and clarifies legacy CLI flag documentation.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
llms.txt Updates index descriptions to remove Polygon-as-supported phrasing.
llms-full.txt Regenerated full-doc export with Polygon scoped as unsupported and adds legacy Polygon flags section.
docs/site/static/llms.txt Static copy of llms.txt regenerated with the same Polygon scoping.
docs/site/static/llms-full.txt Static copy of llms-full.txt regenerated with the same Polygon scoping.
docs/site/src/theme/NotFound/Content/index.tsx Updates 404-page card text to remove Polygon from “Easy Nodes” description.
docs/site/help-center/frequently-asked-questions-faqs.mdx Removes Polygon from FAQ structured-data answer text.
docs/site/help-center/common-errors-and-solutions.md Replaces outdated Heimdall flag reference with --externalcl example.
docs/site/docs/interacting-with-erigon/index.md Clarifies bor namespace is legacy/unsupported for Polygon.
docs/site/docs/interacting-with-erigon/grpc.md Adds warning that Polygon gRPC services are unmaintained/untested.
docs/site/docs/interacting-with-erigon/bor.md Updates page description to remove “Polygon-supported” framing.
docs/site/docs/index.mdx Updates landing-page “Easy Nodes” card text to remove Polygon.
docs/site/docs/get-started/index.mdx Updates “Get Started” “Easy Nodes” card text to remove Polygon.
docs/site/docs/fundamentals/supported-networks.md Removes Polygon from supported mainnet/testnet tables and adds explicit unsupported section.
docs/site/docs/fundamentals/multiple-instances.md Removes a Polygon-specific tuning snippet from examples.
docs/site/docs/fundamentals/layer-2-networks.md Updates page description to remove Polygon/Bor claim.
docs/site/docs/fundamentals/configuring-erigon.mdx Adds “Legacy Polygon flags” header and warning above Bor/Polygon flags.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/site/help-center/frequently-asked-questions-faqs.mdx

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

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

Comment thread docs/site/docs/interacting-with-erigon/grpc.md
Comment thread docs/site/help-center/common-errors-and-solutions.md Outdated
…ag advice

The unsupported-Polygon notice sat only under Polygon Bridge Backend, so a
reader landing on the sibling Heimdall H2 saw the service presented without
it.

--externalcl is a BoolFlag setting cfg.InternalCL, so it carries no address
and cannot explain a dial failure. The advice now names the flags that do
carry one and notes that the external consensus client connects inbound to
the Engine API.

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

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

Suppressed comments (1)

docs/site/help-center/common-errors-and-solutions.md:82

  • This example still reverses the connection direction: Erigon does not dial a consensus-layer endpoint; an external CL dials Erigon's Engine API, as the solution below correctly explains. Use a service Erigon actually dials here so the stated failure matches the troubleshooting flags.
* **Error Description:** The node cannot connect to an external service, such as a local or remote consensus-layer endpoint.

@bloxster

Copy link
Copy Markdown
Collaborator Author

The suppressed comment on docs/site/help-center/common-errors-and-solutions.md:82 was a fair catch. The Error Description offered a consensus-layer endpoint as the example, while the Solution immediately below explains that an external CL connects inbound to Erigon's Engine API — so the entry contradicted itself.

Fixed in 89882d1: the description now names components Erigon genuinely dials out to — a separately run sentry or downloader, and the core instance an external RPC daemon talks to — which matches the flags the Solution already lists (--sentry.api.addr, --downloader.api.addr, --private.api.addr). The --externalcl clarification is unchanged.

@yperbasis yperbasis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Requesting changes for two documentation accuracy issues: the Layer 2 summary overstates Erigon's Optimism role, and the connection-error example does not match the flags in its solution.

Comment thread docs/site/docs/fundamentals/layer-2-networks.md Outdated
Comment thread docs/site/help-center/common-errors-and-solutions.md Outdated

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

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Suppressed comments (3)

Previously missed (2) — in code that hasn't changed since the last review.

docs/site/docs/fundamentals/supported-networks.md:43

  • “Neither … tested” is inaccurate: .github/workflows/qa-rpc-integration-tests-polygon.yml:6-13,22-38,110-135 runs bor-mainnet RPC integration tests on every release/3.* push and PR, while polygon/heimdall/service_test.go:47-96 contains Amoy and Bor-mainnet fixture suites. Describe these targets as unsupported/unmaintained rather than untested, then regenerate the LLM artifacts.
The `bor-mainnet` (137) and `amoy` (80002) chain tags remain selectable in this release and the `bor` namespace is still wired, but neither is maintained or tested. Do not plan a new Polygon deployment on Erigon 3.6.

docs/site/docs/interacting-with-erigon/grpc.md:135

  • The “untested” claim conflicts with the Bridge test suite: polygon/bridge/service_test.go exercises event fetching and block processing, and the package also has client, event-fetch, and snapshot-store tests. Keep the unsupported/unmaintained warning, but remove “untested” and regenerate the LLM artifacts.

This issue also appears on line 162 of the same file.

:::warning
Erigon does not support Polygon — see [Supported Networks](/fundamentals/supported-networks). These services are still built in this release, but they are unmaintained and untested.
:::

docs/site/docs/interacting-with-erigon/grpc.md:164

  • The Heimdall service is not untested: polygon/heimdall/service_test.go:47-130 has full Amoy and Bor-mainnet service suites, with additional client, scraper, range-index, and snapshot-store tests in the package. Say unsupported/unmaintained instead, then regenerate the LLM artifacts.
:::warning
Erigon does not support Polygon — see [Supported Networks](/fundamentals/supported-networks). These services are still built in this release, but they are unmaintained and untested.
:::

Comment thread docs/site/docs/fundamentals/layer-2-networks.md Outdated
@bloxster
bloxster added this pull request to the merge queue Aug 27, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 27, 2026
@bloxster
bloxster removed this pull request from the merge queue due to a manual request Aug 27, 2026
@bloxster
bloxster added this pull request to the merge queue Aug 27, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 27, 2026
@bloxster
bloxster added this pull request to the merge queue Aug 27, 2026
Merged via the queue into release/3.6 with commit 420e5e2 Aug 27, 2026
24 checks passed
@bloxster
bloxster deleted the docs/polygon-framing-r36 branch August 27, 2026 20:57
pull Bot pushed a commit to Dustin4444/erigon that referenced this pull request Sep 1, 2026
…rigontech#23595, erigontech#23625 to main (erigontech#23676)

Ports five docs PRs merged to `release/3.6` between 2026-08-20 and
08-28. Every claim was re-derived against `main`'s own source rather
than copied across — three did not survive that check, and two needed
adapting.

| Ported | Brings |
| --- | --- |
| erigontech#23359 | The state-cache environment variables |
| erigontech#23587 | Caplin block production since v3.6, and the disk-storage
claim in the Caplin intro |
| erigontech#23593 | Pruning Modes: receipt-cache stickiness, `keep-all`, snapshot
reclaim |
| erigontech#23595 | `eth.md` JSON-RPC deviations and `trace.md` withdrawals /
`gasBailOut` |
| erigontech#23625 | The `--externalcl` correction and the Layer 2 page
description |

### Written differently here, because release/3.6 is wrong for main

- **`eth_getFilterLogs` no longer resets a filter's eviction deadline.**
erigontech#23296 rewrote it to read the stored criteria and serve them through the
`eth_getLogs` path, dropping the `TouchSubscription` call `release/3.6`
still makes. A client polling only with `eth_getFilterLogs` loses its
filter after five idle minutes. This documents it as it is, but it reads
like an unintended side effect of erigontech#23296 rather than a deliberate
change.
- **`BlockNumberOrHash.UnmarshalJSON` has a top-level `"latestExecuted"`
case on `main`**, so the bare string works on `eth_call` and friends. On
`release/3.6` only the object-wrapped form does.
- **`eth_fillTransaction` rejects three inputs on `main`** that
`release/3.6` accepts: `gasPrice` with `authorizationList`, an empty
`authorizationList`, and a derived `maxFeePerGas` or `maxFeePerBlobGas`
that overflows 256 bits.
- **The state caches do not start at a flat 1024 entries.** Start is
`max(1024, shards × 16)` bounded by the ceiling, with the shard count
following `min(ceiling/64, GOMAXPROCS × 16)` rounded to powers of two.
`minShardStart` does not exist on `release/3.6` at all.

### Adapted for the Polygon removal (erigontech#23497)

The `gasBailOut` burn-contract note drops the Bor chains, and the
replay-path note drops Bor state-sync transactions.

### Verified unchanged, then ported as written

`eth_getWitness` / `eth_getTxWitness` including the genesis and
empty-access-set early returns; the withdrawals `stateDiff` shapes;
Caplin payload preparation, head publication and default graffiti
(`payload_preparation.go` is byte-identical across the branches); the
`--prune.include-receipts` stickiness warning; and the `STATE_CACHE_*`
defaults, whose "new in v3.6" comparisons check out against
`release/3.5`.

The llms.txt cross-link on `why-using-erigon` is deliberately left out —
it belongs to erigontech#23336.

Follows erigontech#23675. Gate: `npm ci && npm run build` green, `generate-llms.py
--check` OK (72 pages), `render-disk-sizes.py --check` OK, editorial
scan and `sidebar_position` lint clean.

---------

Co-authored-by: Bloxster <gianni.morselli@erigon.tech>
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