docs: Fix broken Admin UI guide links after legacy-apis move#4912
docs: Fix broken Admin UI guide links after legacy-apis move#4912grolmus wants to merge 1 commit into
Conversation
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.
|
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (11)
📝 WalkthroughWalkthroughThis 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 Changes
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 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
biggamesmallworld
left a comment
There was a problem hiding this comment.
@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
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-apisparent indocs/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/**):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 underlegacy-apis > extending-the-admin-uiin the manifest, so every new URL resolves.Test plan
bun run test:mdx(docs validator) passes: 830 files, MDX compilation OK, 0 errors.docs/manifest.jsonthat each new path matches the manifest-derived navigation URL.grepconfirms zero remaining](/extending-the-admin-ui/links indocs/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).
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.