Skip to content

Update readme.md#1997

Merged
elibosley merged 1 commit intounraid:mainfrom
Vitnir:patch-1
Apr 29, 2026
Merged

Update readme.md#1997
elibosley merged 1 commit intounraid:mainfrom
Vitnir:patch-1

Conversation

@Vitnir
Copy link
Copy Markdown
Contributor

@Vitnir Vitnir commented Apr 29, 2026

Update README link to new documentation URL after repository relocation, replacing outdated link that was never updated.

Summary by CodeRabbit

  • Documentation
    • Updated the Usage documentation link to direct users to the latest external documentation resource.

Update README link to new documentation URL after repository relocation, replacing outdated link that was never updated.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 667e9bed-5bc6-4711-947f-6c300d8aefd2

📥 Commits

Reviewing files that changed from the base of the PR and between 865d9cc and 106c75f.

📒 Files selected for processing (1)
  • readme.md

Walkthrough

The README's "Usage" link was updated to redirect from a local relative markdown file path to an external GitHub documentation repository URL, consolidating documentation references.

Changes

Cohort / File(s) Summary
Documentation Link Update
readme.md
Updated "Usage" link from local relative path (./api/docs/public/how-to-use-the-api.md) to external GitHub documentation URL (https://github.com/unraid/docs).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A link once local, now points afar,
To docs in the GitHub star,
One line changed, but oh what cheer,
The path to knowledge, crystal clear! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update readme.md' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific change (updating a documentation link after repository relocation). Use a more specific title that describes the actual change, such as 'Update documentation link in README to point to new GitHub docs repository' or 'Fix outdated API documentation link in README'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

@elibosley elibosley merged commit b5e1b5d into unraid:main Apr 29, 2026
1 check 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.

2 participants