docs: fix relative links to existing doc pages#2879
Open
CTOmari360 wants to merge 1 commit into
Open
Conversation
Several documentation pages linked to other pages using relative paths that overshoot their directory, so the links resolve to non-existent files even though the target pages exist. Correct the paths to point at the existing files: - docs/faq.md -> architecture/health_aggregation.md, observability/core_metrics.md - docs/development.md -> development/vm_pxe_client.md - docs/architecture/overview.md -> ../dpu-management/dpu_configuration.md - docs/operations/tenant-lifecycle-cleanup.md -> ../observability/core_metrics.md Links to pages that no longer exist anywhere in the tree are left out of this change, since their intended targets are ambiguous. Signed-off-by: Omar Refai <omar@refai.org>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
Summary by CodeRabbit
WalkthroughUpdated several documentation links so references on architecture, development, FAQ, and operations pages point to the current relative paths. ChangesDocumentation path updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several documentation pages link to other pages using relative paths that overshoot their directory, so the links resolve to non-existent files even though the target pages exist in the tree. This corrects the relative paths to point at the existing files.
docs/faq.md../architecture/health_aggregation.mdarchitecture/health_aggregation.mddocs/faq.md../observability/core_metrics.mdobservability/core_metrics.mddocs/development.mdvm_pxe_client.mddevelopment/vm_pxe_client.mddocs/architecture/overview.mddpu_configuration.md../dpu-management/dpu_configuration.mddocs/operations/tenant-lifecycle-cleanup.md../manuals/metrics/core_metrics.md../observability/core_metrics.mdEach corrected link was verified to resolve to an existing file.
Related issues
None.
Type of Change
Breaking Changes
Testing
Verified each new relative path resolves to a file that exists in the repository.
Additional Notes
Scope is intentionally limited to broken links whose intended target unambiguously exists. Links to pages that no longer exist anywhere in the tree (e.g.
day_one_operations.md,nico_admin_cli.md) are deliberately left out, since their correct targets are ambiguous. Auto-generated CLI reference docs are also out of scope.