Skip to content

Fix: change link paths to relative#22

Merged
sheepla merged 1 commit intomasterfrom
fix/issue-21-broken-links
May 2, 2026
Merged

Fix: change link paths to relative#22
sheepla merged 1 commit intomasterfrom
fix/issue-21-broken-links

Conversation

@sheepla
Copy link
Copy Markdown
Owner

@sheepla sheepla commented May 2, 2026


Open in Devin Review

Summary by CodeRabbit

  • Documentation
    • Updated documentation references to direct users to the published documentation site
    • Corrected internal documentation navigation links for improved consistency and accessibility

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 178bad5e-4763-4b05-a9f4-1c9259f789fe

📥 Commits

Reviewing files that changed from the base of the PR and between 74463da and 51b0f47.

📒 Files selected for processing (2)
  • README.md
  • docs/src/content/docs/index.mdx

📝 Walkthrough

Walkthrough

The PR updates documentation references across two files: the main README now points external users to the published documentation site at https://sheepla.github.io/AxisEndpoints/ instead of a local path, and internal documentation links are converted from absolute to relative paths for consistency.

Changes

Documentation Link Updates

Layer / File(s) Summary
External Documentation Reference
README.md
The "Documentation" section link is updated from ./docs/ to the published site https://sheepla.github.io/AxisEndpoints/, and a deployment TODO comment is removed.
Internal Documentation Paths
docs/src/content/docs/index.mdx
All internal documentation links in the index page are converted from absolute paths (e.g., /getting-started/installation/) to relative paths (e.g., ./getting-started/installation/).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop through the docs,
Old paths took a rest,
Links now point true,
Both relative and blessed—
Clear roads for all guests! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: converting link paths from absolute to relative in documentation files.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/issue-21-broken-links

Review rate limit: 9/10 reviews remaining, refill in 6 minutes.

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

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

@sheepla sheepla merged commit 32d3b15 into master May 2, 2026
3 of 4 checks passed
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.

1 participant