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

πŸ“ docs: add session config.md #758

Merged
merged 1 commit into from
May 27, 2024

Conversation

blumewas
Copy link
Contributor

❓ Type of change

  • add a session-config.md to better document application-side session handling

  • update nuxt-config.md to match the new types

  • πŸ“– Documentation (updates to the documentation, readme or JSdoc annotations)

  • 🐞 Bug fix (a non-breaking change that fixes an issue)

  • πŸ‘Œ Enhancement (improving an existing functionality like performance)

  • ✨ New feature (a non-breaking change that adds functionality)

  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)

  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

As mentioned in PR #715 the session config needs some love. This PR tries to give the developer a better understanding on how the package handles the session refresh.

@zoey-kaiser
Copy link
Member

Hi @blumewas πŸ‘‹

Thanks for the contribution (and your last PR, which was already merged!) We appreciate it ❀️

The session config needs some love.

I agree that the docs need some DESPERATE love. On that note, we are working on a complete rewrite of the NuxtAuth documentation for V2. We have already begun migrating to VitePress and have outlined a new and better documentation structure to communicate better how to use the Module. You can follow along here: sidebase/docs#180

I will merge this PR and ensure that the new information is also included in the rewrite! Feel free to also give feedback on the new docs and structure in the PR linked above. It would be a great help to hear from the community about what is helpful!

Preview screenshot:

image

@zoey-kaiser zoey-kaiser merged commit faa039b into sidebase:main May 27, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants