Skip to content

docs(router): fix broken swan-io/chicane link in overview.md#7668

Open
sanjibani wants to merge 1 commit into
TanStack:mainfrom
sanjibani:docs/fix-broken-swan-io-chicane-link
Open

docs(router): fix broken swan-io/chicane link in overview.md#7668
sanjibani wants to merge 1 commit into
TanStack:mainfrom
sanjibani:docs/fix-broken-swan-io-chicane-link

Conversation

@sanjibani

@sanjibani sanjibani commented Jun 22, 2026

Copy link
Copy Markdown

Replaces https://swan-io.github.io/chicane/ (404, retired GitHub Pages deployment) with https://github.com/swan-io/chicane (200, canonical repo).

Summary by CodeRabbit

  • Documentation
    • Updated the Chicane library acknowledgement in the router documentation to direct users to its official GitHub repository instead of a third-party reference. Added a clarification note that the previously referenced external documentation site is no longer deployed or available.

The `https://swan-io.github.io/chicane/` GitHub Pages site returns 404
(appears to be a retired deployment). The project still exists at
https://github.com/swan-io/chicane (200).

Replaced the dead link with the GitHub repo URL, which is the canonical
home for the project.
@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

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: 892f9180-bf7d-4cb1-9c16-e311b731bd92

📥 Commits

Reviewing files that changed from the base of the PR and between 279a849 and 04b9b22.

📒 Files selected for processing (1)
  • docs/router/overview.md

📝 Walkthrough

Walkthrough

The Chicane acknowledgement link in docs/router/overview.md is updated from the previously hosted docs URL to the GitHub repository URL (github.com/swan-io/chicane), with a parenthetical note added stating the docs site is no longer deployed.

Changes

Chicane Link Update

Layer / File(s) Summary
Update Chicane acknowledgement URL
docs/router/overview.md
Changes the Chicane hyperlink from the old hosted docs URL to the GitHub repository URL and adds a note that the docs site is no longer deployed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~1 minute

Poem

A link grew stale, the docs site gone away,
So the rabbit dug a new path to GitHub today.
One line changed, one URL set right,
The chicane still runs — just follow the light! 🐇✨

🚥 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 describes the main change: fixing a broken documentation link in the router's overview.md file by updating the Chicane acknowledgement reference.
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

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

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