Skip to content

Conversation

@an1ndra
Copy link
Contributor

@an1ndra an1ndra commented Sep 28, 2025

Updated wrong Tanstack Start + Bun example URL

Summary by CodeRabbit

  • Documentation
    • Updated the Hosting guide to replace a relative repository link with an absolute GitHub URL in the Bun deployment section.
    • Improves reliability and clarity of the example reference, preventing broken or ambiguous links.
    • No functional or behavioral changes to the product; this is a documentation-only update aimed at better navigation and consistency for readers.

Updated wrong Tanstack Start + Bun example URL
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 28, 2025

Walkthrough

Updated a documentation link in docs/start/framework/react/hosting.md, changing a relative repository path to an absolute GitHub URL in the Bun deployment section. No code, behavior, or control-flow modifications.

Changes

Cohort / File(s) Summary
Docs link update
docs/start/framework/react/hosting.md
Replaced a relative example link with an absolute GitHub URL in the Bun deployment section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

documentation

Poem

I nibbled a link with careful might,
From paths relative to GitHub light—
A hop, a skip, no code to mend,
Just breadcrumbs clearer to the end.
Bun in paw, I bounce with glee,
Docs aligned, as neat as can be. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “Update wrong link” accurately refers to the change but is too generic to convey which link or documentation section is affected, making it unclear for someone scanning the history to understand the specific update. Please revise the title to clearly identify the context and target of the link update, for example “Fix Bun deployment example link in React hosting documentation.”
✅ Passed checks (2 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 changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 04af815 and 97f5345.

📒 Files selected for processing (1)
  • docs/start/framework/react/hosting.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (AGENTS.md)

Use internal docs links relative to the docs/ folder (e.g., ./guide/data-loading)

Files:

  • docs/start/framework/react/hosting.md
docs/{router,start}/**

📄 CodeRabbit inference engine (AGENTS.md)

Place router docs under docs/router/ and start framework docs under docs/start/

Files:

  • docs/start/framework/react/hosting.md
🔇 Additional comments (1)
docs/start/framework/react/hosting.md (1)

310-310: Link fix resolves the 404

Directing folks to the GitHub example avoids the broken docs URL and gets them to the working starter right away. Nice catch.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

@github-actions github-actions bot added the documentation Everything documentation related label Sep 28, 2025
@schiller-manuel schiller-manuel merged commit 5b07046 into TanStack:main Sep 28, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants