Skip to content

docs: fix README documentation links#231

Merged
pratyush618 merged 1 commit into
masterfrom
docs/fix-readme-doc-links
Jun 1, 2026
Merged

docs: fix README documentation links#231
pratyush618 merged 1 commit into
masterfrom
docs/fix-readme-doc-links

Conversation

@pratyush618
Copy link
Copy Markdown
Collaborator

@pratyush618 pratyush618 commented Jun 1, 2026

The README's documentation links pointed at docs.byteveda.org/taskito/docs/..., but the docs site serves these pages without the /docs path segment — so every guide link 404'd.

Drops the stale /docs segment from all eight affected links (capabilities, the six guide links, and the migration guide). The two already-correct bare /taskito links were left untouched.

Summary by CodeRabbit

  • Documentation
    • Updated documentation links in README across Features (Capabilities, Reliability, Workflows, Scheduling, Dashboard, Extensibility) and Celery migration reference sections to reflect new URL paths.

@github-actions github-actions Bot added the docs label Jun 1, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 1, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cb6be100-3ae5-495c-8636-422ea462853b

📥 Commits

Reviewing files that changed from the base of the PR and between 92c52cc and 23ece9e.

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

📝 Walkthrough

Walkthrough

Eight documentation URLs in README.md are updated from /docs/... paths to /taskito/guides/... URLs across the Features section (Capabilities, Reliability, Workflows, Execution & prefork, Scheduling, Dashboard & monitoring, Extensibility) and the Celery migration reference.

Changes

README Documentation Links

Layer / File(s) Summary
Update all documentation link URLs
README.md
Eight documentation links are updated from /docs/... paths to /taskito/guides/... URLs across the Features section (Capabilities, Reliability, Workflows, Execution & prefork, Scheduling, Dashboard & monitoring, Extensibility) and the Celery migration reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • ByteVeda/taskito#230: Both PRs modify README.md's "Features" documentation links and structure; this PR updates the /docs/... URLs to the /taskito/... scheme introduced in the prior PR.

Suggested labels

docs

Poem

A rabbit hops through links so bright,
From /docs/ to /taskito/ paths in sight,
Each guide now points the proper way,
Doc routes dance in disarray—no, hooray! 🐰✨

🚥 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 PR title 'docs: fix README documentation links' directly and accurately reflects the main change: correcting broken documentation links in the README by removing the stale '/docs' path segment.
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 docs/fix-readme-doc-links

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

@pratyush618 pratyush618 merged commit 7f2d3ba into master Jun 1, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant