Fix broken web-components doc links in admin (2026-04)#4537
Conversation
|
We detected some changes in |
|
This PR targets a stable release branch ( When you open the forward-port PR, include a line like this in its body so the Accepted formats (comma-separated for multiple):
If a forward-port isn't needed (e.g., the change is stable-only), you can remove the |
Admin component JSDoc linked to the old `using-web-components` slug (both `polaris/` and `app-ui/` prefixes). That slug 301-redirects to the canonical page, and the redirect drops the URL `#fragment`, so links like SpacingKeyword (#scale) and responsive value (#responsive-values) landed at the top of the page instead of the section. Restore the canonical slug everywhere: (polaris|app-ui)/using-web-components -> polaris/using-polaris-web-components Updates the 9 source .d.ts files and the checked-in v2 docs data (app_home, admin_extensions/2026-04). Links-only diff, 157 occurrences. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
76c4798 to
88bc8ab
Compare
gwyneplaine
left a comment
There was a problem hiding this comment.
failing on auth token issue, but changes lgtm
Problem
These links were broken. Admin component JSDoc linked to the old
using-web-componentsslug, which no longer resolves correctly. There were two failure modes, both live on production:/docs/api/polaris/using-web-components#…(most links)/docs/api/app-ui/using-web-components#…#fragment, landing at the top instead of the section/docs/api/polaris/using-polaris-web-components#…So links such as
SpacingKeyword(#scale) and responsive value (#responsive-values) either 404’d outright or dumped the reader at the top of the page instead of the intended section.Fix
Restore the canonical slug everywhere in the admin surface:
Links-only diff (no content/symbol changes). Touches the source
.d.tsfiles and the checked-in v2 docs data.🤖 Generated with Claude Code
Part of a set fixing this across all affected versions: #4538 (2025-10), #4539 (2026-01), #4537 (2026-04), #4536 (2026-07-rc).