fix(docs): typo in getting-started/appdir docs

[notEpsilon]

Summary by CodeRabbit

• Documentation
  • Enhanced documentation for setting up the Next.js App Router with UploadThing.
  • Added a new section on improving server-side rendering (SSR) with the <NextSSRPlugin /> component.
  • Corrected the import statement for the connection function and provided usage guidance.
  • Retained the section on creating a Next.js API route using the FileRouter for comprehensive user guidance.

[changeset-bot]

⚠️ No Changeset found

Latest commit: b703136

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 2, 2024 10:07am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
legacy-docs-uploadthing	⬜️ Ignored (Inspect)	Visit Preview		Nov 2, 2024 10:07am

[coderabbitai]

Walkthrough

The changes in this pull request focus on enhancing the documentation for integrating UploadThing with the Next.js App Router. Key updates include a new section detailing server-side rendering (SSR) improvements using the <NextSSRPlugin />, along with a corrected import statement for the connection function. The documentation clarifies how to utilize the plugin within a Suspense component, ensuring optimal performance. The structure remains consistent, preserving the existing guidance on creating a Next.js API route with FileRouter.

Changes

File Path	Change Summary
docs/src/app/(docs)/getting-started/appdir/page.mdx	Added section on SSR improvements with <NextSSRPlugin />, corrected import of connection, and clarified usage in Suspense.
app/layout.tsx	Renamed variable connnection to connection.

Possibly related PRs

• docs: Add getting started for tanstack/start #973: This PR adds a "getting started" guide for the Tanstack/Start library, which includes updates related to UploadThing, similar to the main PR's focus on integrating UploadThing with Next.js.
• docs: Fixed SolidStart and slightly changed Tanstack/Start #988: This PR includes changes to the Tanstack/Start documentation that enhance clarity and consistency with UploadThing, directly relating to the main PR's updates on UploadThing's integration with Next.js.
• chore: add minimal-tanstack-start example #989: Although primarily a chore to add an example, it relates to the overall context of using UploadThing with Tanstack, which is relevant to the main PR's focus on documentation improvements for UploadThing.

Suggested labels

📚 documentation

Suggested reviewers

• juliusmarminge

🐰 In the meadow, where knowledge blooms,
A guide emerges, dispelling the glooms.
With SSR magic and connections so bright,
UploadThing dances in the Next.js light!
Hop along, dear friends, to learn and explore,
For in these docs, there’s wisdom galore! 🌼✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

docs/src/app/(docs)/getting-started/appdir/page.mdx (1)

243-243: LGTM! The import statement is now correctly spelled.

The fix for the connection import typo and the surrounding example code accurately demonstrates the proper usage with experimental Next.js features.

Consider improving the code example's formatting for better readability:

async function UTSSR() {
  await connection();
-  return <NextSSRPlugin routerConfig={extractRouterConfig(ourFileRouter)} />
+  return (
+    <NextSSRPlugin 
+      routerConfig={extractRouterConfig(ourFileRouter)} 
+    />
+  );
}

export default function RootLayout(props) {
  return (
    <html>
-      {...}
+      <head />
      <body>
        <Suspense>
          <UTSSR />
        </Suspense>
-      {...}
        {props.children}
      </body>
    </html>
  );
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1b23106 and b703136.

📒 Files selected for processing (1)

• docs/src/app/(docs)/getting-started/appdir/page.mdx (1 hunks)