fix(polygon-zkevm): pin endpoint slug so overview links resolve - #1387
Merged
Conversation
The content-indexer derives the API section slug via kebabCase("Polygon
zkEVM API Endpoints"), which splits zkEVM into "zk-evm" and produces
polygon-zk-evm-api-endpoints. The overview/FAQ link convention uses
polygon-zkevm-api-endpoints, so all 53 overview links 404'd after the
Daikon spec update (#1377) rewrote them to the simple form.
Pin slug: polygon-zkevm-api-endpoints on the api entry so endpoint URLs
match the link convention and stay stable across future spec regens.
Add redirects from the previously-live split form (and legacy /node
path) to the pinned slug, and update FAQ links to the canonical form.
Co-Authored-By: Claude <noreply@anthropic.com>
🔗 Preview Mode
|
The polygon-zkevm-api-overview.mdx file existed but was never referenced in docs.yml, so it wasn't part of the sidebar navigation. Add the page entry after FAQ and before the API Endpoints, matching the ordering used by Polygon PoS and the other chain sections. Co-Authored-By: Claude <noreply@anthropic.com>
dslovinsky
marked this pull request as ready for review
June 15, 2026 21:46
SahilAujla
approved these changes
Jun 15, 2026
dslovinsky
pushed a commit
that referenced
this pull request
Jun 15, 2026
…block) (#1385) https://bitsofco.de/solidity-function-visibility-explained/ was flagged by the weekly link check with 'Network error: Connection failed', but the page loads fine from this session (3 consecutive curl 200s in ~100ms with both default and lychee user-agents). Treat as intermittent crawler-block, matching the existing geth.ethereum.org / portal.zksync.io pattern. Originally part of DOCS-118 alongside polygon-zkevm slug + katana quickstart fixes; those have been handled separately in #1386 and #1387, so this PR is now scoped to the one remaining lychee config change. Refs DOCS-118
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The weekly link check flagged 53 broken
polygon-zkevmAPI endpoint links (all 404s). Slack threadRoot cause: the URL segment for the API section is derived two different ways that disagree on
zkEVM:src/content-indexer/visitors/process-openrpc.ts, what's actually live):kebabCase("Polygon zkEVM API Endpoints")→polygon-zk-evm-api-endpointspolygon-zkevm-api-endpointsThe links were correct until the Daikon spec update (#1377) regenerated the overview table and rewrote all 53 links from
polygon-zk-evm-api-endpointstopolygon-zkevm-api-endpoints, which no longer matched the live route → 404s. Only zkEVM regressed; the other inner-cap chains' overview links already match their routes.Fix (pin the slug — fix URL generation)
Rather than re-editing links (which Daikon would re-break), pin the section slug so the route matches the link convention and stays stable across future spec regenerations:
content/docs.yml— addslug: polygon-zkevm-api-endpointsto thePolygon zkEVM API Endpointsentry. The schema (docs-yml.schema.json) supports this; the indexer honorsapiConfig.slug ?? kebabCase(...).content/redirects.yml— the previously-live canonical waspolygon-zk-evm-api-endpoints, so:/docs/chains/polygon-zkevm/polygon-zk-evm-api-endpoints/:method*→…/polygon-zkevm-api-endpoints/:method*to preserve external/indexed links;/node/redirect (which sent the simple form to the split form — now backwards) straight to the new/chains/canonical, avoiding a self-loop/multi-hop chain.polygon-zkevm-and-ethereum-differences.mdx) — update its 16 internal links to the canonical form so they resolve directly instead of via a redirect.Verification
docs.ymlvalidates againstdocs-yml.schema.json.polygon-zk-evm-api-endpointsreferences incontent/except the intentional redirect source.🤖 Generated with Claude Code