chore(docs): enhance API reference description for next-auth/react (#11874)

halvaradop · balazsorban44 · web-flow · commit 2f8320cde977 · 2024-09-25T09:28:19.000+01:00
* chore(docs): enhance API reference description for next-auth/react

* Apply suggestions from code review

---------

Co-authored-by: Balázs Orbán &lt;info@balazsorban.com&gt;
diff --git a/packages/next-auth/src/react.tsx b/packages/next-auth/src/react.tsx
@@ -1,6 +1,9 @@
 /**
  *
- * NextAuth.js methods and components that work in [Client components](https://nextjs.org/docs/app/building-your-application/rendering/client-components) and the [Pages Router](https://nextjs.org/docs/pages).
+ * NextAuth.js is the official integration of Auth.js for Next.js applications. It supports both
+ * [Client Components](https://nextjs.org/docs/app/building-your-application/rendering/client-components) and the
+ * [Pages Router](https://nextjs.org/docs/pages). It includes methods for signing in, signing out, hooks, and a React
+ * Context provider to wrap your application and make session data available anywhere.
  *
  * For use in [Server Actions](https://nextjs.org/docs/app/api-reference/functions/server-actions), check out [these methods](https://authjs.dev/guides/upgrade-to-v5#methods)
  *

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,9 @@`
`1`	`1`	`/**`
`2`	`2`	`*`
`3`		`- * NextAuth.js methods and components that work in [Client components](https://nextjs.org/docs/app/building-your-application/rendering/client-components) and the [Pages Router](https://nextjs.org/docs/pages).`
	`3`	`+ * NextAuth.js is the official integration of Auth.js for Next.js applications. It supports both`
	`4`	`+ * [Client Components](https://nextjs.org/docs/app/building-your-application/rendering/client-components) and the`
	`5`	`+ * [Pages Router](https://nextjs.org/docs/pages). It includes methods for signing in, signing out, hooks, and a React`
	`6`	`+ * Context provider to wrap your application and make session data available anywhere.`
`4`	`7`	`*`
`5`	`8`	`* For use in [Server Actions](https://nextjs.org/docs/app/api-reference/functions/server-actions), check out [these methods](https://authjs.dev/guides/upgrade-to-v5#methods)`
`6`	`9`	`*`