Skip to content

Fix broken web-components doc links in admin (2026-04)#4537

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

Fix broken web-components doc links in admin (2026-04)#4537
sordaz00 wants to merge 1 commit into
2026-04from
fix/app-home-wc-links-2026-04

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).

@sordaz00 sordaz00 requested a review from a team July 1, 2026 01:37
@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.

@github-actions github-actions Bot added the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label Jul 1, 2026
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

This PR targets a stable release branch (2026-04). Once merged, the change typically also needs to be forward-ported to 2026-07-rc so it ships in the next release.

When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:

Forward-port of #4537

Accepted formats (comma-separated for multiple):

  • #4537
  • GH-4537
  • 4537
  • https://github.com/Shopify/ui-extensions/pull/4537

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

@sordaz00 sordaz00 changed the title Fix broken web-components doc links in admin surface (2026-04) Fix broken web-components doc links in app home (2026-04) Jul 1, 2026
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>
@sordaz00 sordaz00 force-pushed the fix/app-home-wc-links-2026-04 branch from 76c4798 to 88bc8ab Compare July 1, 2026 13:39
@sordaz00 sordaz00 changed the title Fix broken web-components doc links in app home (2026-04) Fix web-components doc links to land on section anchors (2026-04) Jul 1, 2026
@sordaz00 sordaz00 changed the title Fix web-components doc links to land on section anchors (2026-04) Fix broken web-components doc links in admin (2026-04) Jul 1, 2026
@sordaz00 sordaz00 removed the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label Jul 1, 2026

@gwyneplaine gwyneplaine 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.

failing on auth token issue, but changes lgtm

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.

6 participants