Skip to content

Fix broken web-components doc links in admin (2026-07-rc)#4536

Open
sordaz00 wants to merge 1 commit into
2026-07-rcfrom
fix/app-home-wc-links-2026-07-rc
Open

Fix broken web-components doc links in admin (2026-07-rc)#4536
sordaz00 wants to merge 1 commit into
2026-07-rcfrom
fix/app-home-wc-links-2026-07-rc

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
@sordaz00 sordaz00 changed the title Fix broken web-components doc links in admin surface (2026-07-rc) Fix broken web-components doc links in app home (2026-07-rc) Jul 1, 2026
@sordaz00 sordaz00 force-pushed the fix/app-home-wc-links-2026-07-rc branch from 0c6aa24 to 14ebbd4 Compare July 1, 2026 13:39
@sordaz00 sordaz00 changed the title Fix broken web-components doc links in app home (2026-07-rc) Fix web-components doc links to land on section anchors (2026-07-rc) Jul 1, 2026
@sordaz00 sordaz00 changed the title Fix web-components doc links to land on section anchors (2026-07-rc) Fix broken web-components doc links in admin (2026-07-rc) Jul 1, 2026

sordaz00 commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

Merge activity

  • Jul 2, 2:41 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 2, 2:42 PM UTC: Graphite rebased this pull request as part of a merge.
  • Jul 2, 2:42 PM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (At least 1 approving review is required by reviewers with write access).
  • Jul 2, 2:43 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 2, 2:43 PM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (At least 1 approving review is required by reviewers with write access).
  • Jul 2, 3:06 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 2, 3:06 PM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (At least 1 approving review is required by reviewers with write access).
  • Jul 2, 3:56 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 2, 3:56 PM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (At least 1 approving review is required by reviewers with write access).
  • Jul 2, 6:27 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 2, 6:28 PM UTC: Graphite rebased this pull request as part of a merge.
  • Jul 2, 6:28 PM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (At least 1 approving review is required by reviewers with write access).
  • Jul 2, 11:14 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Jul 2, 11:15 PM UTC: Graphite rebased this pull request as part of a merge.
  • Jul 2, 11:16 PM UTC: Graphite couldn't merge this PR because it failed for an unknown reason (At least 1 approving review is required by reviewers with write access).

@sordaz00 sordaz00 force-pushed the fix/app-home-wc-links-2026-07-rc branch from 14ebbd4 to f8b2882 Compare July 2, 2026 14:41
@sordaz00 sordaz00 force-pushed the fix/app-home-wc-links-2026-07-rc branch from f8b2882 to a337812 Compare July 2, 2026 18:27
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,
app_home_ui_extension/2026-07-rc, admin_extensions/2026-07-rc). Links-only
diff, 201 occurrences.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@sordaz00 sordaz00 force-pushed the fix/app-home-wc-links-2026-07-rc branch from a337812 to a41935c Compare July 2, 2026 23:15
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