Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: NextAuth documentation update for app router #1882

Open
akshithio opened this issue May 10, 2024 · 4 comments
Open

feat: NextAuth documentation update for app router #1882

akshithio opened this issue May 10, 2024 · 4 comments
Labels
🌟 enhancement New feature or request

Comments

@akshithio
Copy link

akshithio commented May 10, 2024

Is your feature request related to a problem? Please describe.

The NextAuth documentation describes the use of <SessionProvider /> that is the recommended practice for versions of Next.js prior to 14. The documentation also doesn't reflect the actual state of create-t3-app since it now uses the getServerSession hook instead and the page routing alongside the code snippets are not up to date.

Describe the solution you'd like to see

An update to the documentations describing the use of getServerSession alongside updated code snippets that match the repository and matching explanations.

Describe alternate solutions

Provide a user alert at the top of the page stating that the documentation may be outdated and is currently being updated to reflect the actual state of create-t3-app

Additional information

No response

@akshithio akshithio added the 🌟 enhancement New feature or request label May 10, 2024
@akshithio
Copy link
Author

akshithio commented May 11, 2024

I'd be happy to potentially send in a pull request that updates documentation for this specific page, unless the team is working on some sort of complete overhaul on documentation for the /app router updates and if such a PR would interfere with that process.

@juliusmarminge
Copy link
Member

I'd be happy to potentially send in a pull request that updates documentation for this specific page, unless the team is working on some sort of complete overhaul on documentation for the /app router updates and if such a PR would interfere with that process.

No, we don't really have the manpower to do that so we're relying on the community for these things. Would love to accept a PR :)

@DigitalNaut
Copy link

I'd suggest upping the priority on this one. As a new user, this project has a steep learning curve and it's more pronounced with outdated documentation.

@akshithio
Copy link
Author

akshithio commented May 24, 2024

Working on it since yesterday (had school before that)! In all honesty I think essentially alerting to the fact that the Client Provider section is in some sense outdated and slightly editing the server side information is all that it takes considering that not a whole lot has technically changed. create-t3-app seems to have had support for server-side auth much before it was the "recommended" way to do things. Seems like it's a smaller change than I had initially thought it would be when I wrote the issue and I'm working on it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌟 enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants