docs: clarify use cases and document nextjs

[aeneasr]

Needs ory/docs#1730 to be merged

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
elements-nextjs-app-router	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 28, 2025 8:06am
elements-nextjs-pages-router	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 28, 2025 8:06am

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2c89e57

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.

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

[changeset-bot]

⚠️ No Changeset found

Latest commit: 268bb07

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.

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 50.21%. Comparing base (f3fad4d) to head (2c89e57).
Report is 159 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #490      +/-   ##
==========================================
+ Coverage   42.43%   50.21%   +7.78%     
==========================================
  Files         136      153      +17     
  Lines        2008     2585     +577     
  Branches      288      387      +99     
==========================================
+ Hits          852     1298     +446     
- Misses       1149     1266     +117     
- Partials        7       21      +14     

Components	Coverage Δ
@ory/elements-react	47.23% <ø> (+10.44%)	⬆️
@ory/nextjs	63.03% <ø> (-2.95%)	⬇️

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull Request Overview

A concise documentation update PR clarifying the use cases of the Next.js SDK for Ory by updating package-specific and global README files.

• Updated the Next.js README to include a note on usage for developing custom UI components and configuration details for middleware.
• Clarified the configuration requirements (e.g., NEXT_PUBLIC_ORY_SDK_URL) for local development.
• Added guidance in the global README to direct users toward the Auth.js integration guide if custom UI components are not needed.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
packages/nextjs/README.md	Revised documentation to better clarify the use cases and middleware configuration for both app and page routers.
README.md	Updated global instructions for users to follow the Auth.js guide for authentication without UI changes.

[Copilot]

Pull Request Overview

This PR updates documentation for the Next.js package and overall repository by clarifying use cases and configuration details.

• In packages/nextjs/README.md, a note and use case section have been added to explain when to use the middleware and how it supports both app and page routers.
• In README.md, guidance for users opting to integrate authentication without altering their UI is provided with a link to the Auth.js guide.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
packages/nextjs/README.md	Expanded documentation with a note, use cases, and configuration info for the middleware.
README.md	Added guidance and link for users using Auth.js instead of custom components.