Skip to content

Fix broken web components links in Admin API descriptions (2026-01)#4539

Open
sordaz00 wants to merge 1 commit into
2026-01from
fix/app-home-wc-links-2026-01
Open

Fix broken web components links in Admin API descriptions (2026-01)#4539
sordaz00 wants to merge 1 commit into
2026-01from
fix/app-home-wc-links-2026-01

Conversation

@sordaz00

@sordaz00 sordaz00 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Problem

These links were broken. Admin component JSDoc linked to the old using-web-components slug, which no longer resolves correctly. There were two failure modes, both live on production:

Link in source HTTP Result
/docs/api/polaris/using-web-components#… (most links) 404 Page not found — hard broken
/docs/api/app-ui/using-web-components#… 301 Redirects to the canonical page but drops the #fragment, landing at the top instead of the section
/docs/api/polaris/using-polaris-web-components#… 200 Correct — anchors resolve ✓

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:

(polaris|app-ui)/using-web-components  ->  polaris/using-polaris-web-components

Links-only diff (no content/symbol changes). Touches the source .d.ts files 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).

Admin component JSDoc linked to the old `using-web-components` slug (both
`polaris/` and `app-ui/` prefixes). `polaris/using-web-components` 404s, and
`app-ui/using-web-components` 301-redirects to the canonical page while
dropping the URL `#fragment` — so links like SpacingKeyword (#scale) and
responsive value (#responsive-values) either 404d or 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

Links-only diff. Updates source .d.ts files and checked-in v2 docs data.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@sordaz00 sordaz00 changed the title Fix web-components doc links to land on section anchors (2026-01) Fix broken web components links in Admin API descriptions Jul 1, 2026
@sordaz00 sordaz00 changed the title Fix broken web components links in Admin API descriptions Fix broken web components links in Admin API descriptions (2026-01) Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants