Skip to content

docs: wrong link to bun server implementation in hosting page#5272

Merged
schiller-manuel merged 1 commit intoTanStack:mainfrom
MatteoGauthier:patch-1
Sep 28, 2025
Merged

docs: wrong link to bun server implementation in hosting page#5272
schiller-manuel merged 1 commit intoTanStack:mainfrom
MatteoGauthier:patch-1

Conversation

@MatteoGauthier
Copy link
Contributor

@MatteoGauthier MatteoGauthier commented Sep 28, 2025

Summary by CodeRabbit

  • Documentation
    • Updated Quick Setup instructions to copy the example server file from a GitHub URL instead of a local relative path.
    • Improves clarity and reduces friction by pointing to a single, canonical source for the example file.
    • No functional or behavioral changes; this is an instructional update only.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 28, 2025

Walkthrough

Updated React hosting documentation to instruct copying server.ts from a GitHub URL instead of a local relative path in the Quick Setup section. No code, logic, or API changes.

Changes

Cohort / File(s) Summary of Changes
Documentation: React Hosting Quick Setup
docs/start/framework/react/hosting.md
Modified Quick Setup step to reference server.ts via a GitHub URL rather than a local relative path; no other content or logic changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

documentation

Poem

A bunny hops through docs so bright,
Swaps a path—now GitHub’s in sight.
No code to chase, no tests to run,
Just clearer steps beneath the sun.
Hippity-hop, the guide’s now tight—
Copy from the cloud, set up right! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly states that the documentation link to the Bun server implementation on the hosting page was incorrect and needs correction, directly reflecting the change made in docs/start/framework/react/hosting.md. It is concise, specific, and follows the conventional commit style for documentation updates.
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 b4e370e and a16bf83.

📒 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)

248-248: Good fix on the Bun server link.

Pointing to the canonical GitHub source ensures readers land on the actual server.ts they need to copy. Thanks for tightening up the docs.

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 b19e0b9 into TanStack:main Sep 28, 2025
2 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 28, 2025
naoya7076 pushed a commit to naoya7076/router that referenced this pull request Feb 15, 2026
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