Skip to content

docs: Fix broken Admin UI guide links after legacy-apis move#4912

Closed
grolmus wants to merge 1 commit into
vendurehq:masterfrom
grolmus:mgrolmus/oss-514-fix-broken-admin-ui-translations-docs-link
Closed

docs: Fix broken Admin UI guide links after legacy-apis move#4912
grolmus wants to merge 1 commit into
vendurehq:masterfrom
grolmus:mgrolmus/oss-514-fix-broken-admin-ui-translations-docs-link

Conversation

@grolmus

@grolmus grolmus commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fixes broken internal documentation links to the Angular Admin UI ("extending the Admin UI") guides. The originally reported case was the "Adding Admin UI Translations" link (OSS-514), but the same breakage affects every link to those pages — 15 links across 11 manual guide files.

Root cause

The Angular Admin UI guides were moved under a new legacy-apis parent in docs/manifest.json. Guide URLs are derived from the manifest slug chain, so these pages now live at /legacy-apis/extending-the-admin-ui/<slug>/. The internal markdown links were never updated and still pointed at the old /extending-the-admin-ui/<slug>/ paths, which now return 404.

Change

Mechanical link-prefix update in manual guides only (docs/docs/guides/**):

](/extending-the-admin-ui/  ->  ](/legacy-apis/extending-the-admin-ui/

Path anchors (#providers, #route-config, #routes, #compiling-as-a-deployment-step) and sub-slugs are preserved. All 8 referenced target slugs were verified to exist under legacy-apis > extending-the-admin-ui in the manifest, so every new URL resolves.

Test plan

  • bun run test:mdx (docs validator) passes: 830 files, MDX compilation OK, 0 errors.
  • Verified against docs/manifest.json that each new path matches the manifest-derived navigation URL.
  • grep confirms zero remaining ](/extending-the-admin-ui/ links in docs/docs/guides/.

Out of scope (follow-up)

3 further occurrences of the same stale path exist in auto-generated reference docs (docs/docs/reference/...) and are intentionally not edited here — they are regenerated from JSDoc and would be overwritten. The real source lives in:

  • packages/core/src/service/services/history.service.ts (custom-timeline-components)
  • packages/ui-devkit/src/compiler/types.ts (getting-started)
  • packages/common/src/shared-types.ts (adding-ui-translations)

Tracked separately from this docs-guides PR.

Relates to OSS-514 (no linked GitHub issue; original report came via the docs bug-report form).


View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

The Angular Admin UI guides were moved under a 'legacy-apis' parent in the
docs manifest, so their URLs are now /legacy-apis/extending-the-admin-ui/...
Internal links still pointed at the old /extending-the-admin-ui/... paths and
404'd. Updates all 15 stale links across 11 manual guide files.

Relates to OSS-514.
@vendure-developer-hub

vendure-developer-hub Bot commented Jul 1, 2026

Copy link
Copy Markdown

Docs previewPR closed

@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
vendure-storybook Ready Ready Preview, Comment Jul 1, 2026 5:32pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 89518aa9-94f5-4643-9dfd-d3b8ffcd52d2

📥 Commits

Reviewing files that changed from the base of the PR and between 32d4746 and de0bd70.

📒 Files selected for processing (11)
  • docs/docs/guides/deployment/deploying-admin-ui.mdx
  • docs/docs/guides/developer-guide/custom-fields/index.mdx
  • docs/docs/guides/developer-guide/translations/index.mdx
  • docs/docs/guides/extending-the-admin-ui/creating-detail-views/index.mdx
  • docs/docs/guides/extending-the-admin-ui/custom-form-inputs/index.mdx
  • docs/docs/guides/extending-the-admin-ui/custom-timeline-components/index.mdx
  • docs/docs/guides/extending-the-admin-ui/dashboard-widgets/index.mdx
  • docs/docs/guides/extending-the-admin-ui/defining-routes/index.mdx
  • docs/docs/guides/extending-the-admin-ui/getting-started/index.mdx
  • docs/docs/guides/extending-the-admin-ui/nav-menu/index.mdx
  • docs/docs/guides/extending-the-admin-ui/using-other-frameworks/index.mdx

📝 Walkthrough

Walkthrough

This pull request updates hyperlink targets across twelve documentation mdx files under docs/docs/guides. Most links referencing Admin UI extension guides (getting-started, defining-routes, nav-menu, custom-form-inputs, creating-detail-views, dashboard-widgets, custom-timeline-components, using-other-frameworks, custom-fields, translations, deploying-admin-ui) were changed to point to new /legacy-apis/extending-the-admin-ui/... paths, while one link in custom-form-inputs/index.mdx was updated to point away from a legacy path to the current getting-started guide. No content, code samples, or exported/public entity declarations were otherwise changed.

Changes

Cohort / File(s) Change Summary
Deployment and translations guides Updated hyperlink targets to /legacy-apis/... paths
Custom fields guide Updated two reference links to /legacy-apis/... paths
Core extending-admin-ui guides (getting-started, defining-routes, nav-menu, using-other-frameworks) Updated link targets to /legacy-apis/... paths
UI component guides (creating-detail-views, custom-timeline-components, dashboard-widgets, custom-form-inputs) Updated link targets, mostly to /legacy-apis/... paths, with one link updated to a current (non-legacy) path

Sequence Diagram(s)

Not applicable; changes are limited to documentation hyperlink URL updates with no code behavior or execution flow changes.

Estimated code review effort: 1 (Low) — link-only text changes across mdx files.

Related PRs: None identified from the provided information.

Related issues: None identified from the provided information.

Suggested labels: documentation

Suggested reviewers: None identified from the provided information.

Poem
A rabbit hopped through docs at night,
Swapping paths to make them right,
Legacy links now lead the way,
Save one that turned the other way,
Twelve files touched, all tidy and light. 🐇📄

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: fixing broken Admin UI guide links after the legacy-apis move.
Description check ✅ Passed The description covers the summary, root cause, change, test plan, and issue reference, though some template sections are unfilled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@biggamesmallworld biggamesmallworld left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@grolmus this looks solid but I think as it is regarding the legacy admin UI, it's probably pretty low impact - I think it's harmless to merge but also not 100% necessary

@grolmus grolmus closed this Jul 6, 2026
@vendure-ci-automation-bot vendure-ci-automation-bot Bot locked and limited conversation to collaborators Jul 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants