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

[Content]: Improvements for the session docs #1034

Open
amirhhashemi opened this issue Jan 25, 2025 · 0 comments · May be fixed by #1072
Open

[Content]: Improvements for the session docs #1034

amirhhashemi opened this issue Jan 25, 2025 · 0 comments · May be fixed by #1072
Assignees
Labels
in progress Someone is currently working on the issue.

Comments

@amirhhashemi
Copy link
Collaborator

📚 Subject area/topic

Session

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/solid-start/advanced/session

📋 Description of content that is out-of-date or incorrect

I have a few suggestions for improving the session docs.

  • The docs would benefit from a clear definition of "session" and examples of common use cases (e.g., authentication, user preferences).
  • The introduction ("When user information is required...") is confusing. Rephrasing to clarify why we need sessions would be helpful.
  • cache is deprecated and should be updated.
  • The docs states Nitro provides session helpers, but they are re-exported from h3 via Vinxi.
  • Examples:
    • File paths starting with "/" are confusing. Clarifying their context (project root or src) would be good.
    • FormData seems unnecessary in the last example.
    • Examples can be more readable by simply adding empty lines. The code is very compact.

I'd be happy to send a PR with proposed changes. I would probably re-write it completely. Would you be open to that?

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@amirhhashemi amirhhashemi added the pending review Awaiting review by team members. label Jan 25, 2025
@amirhhashemi amirhhashemi added in progress Someone is currently working on the issue. and removed pending review Awaiting review by team members. labels Feb 8, 2025
@amirhhashemi amirhhashemi linked a pull request Feb 13, 2025 that will close this issue
2 tasks
@amirhhashemi amirhhashemi added wait to merge and removed in progress Someone is currently working on the issue. labels Feb 15, 2025
@LadyBluenotes LadyBluenotes added in progress Someone is currently working on the issue. and removed wait to merge labels Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in progress Someone is currently working on the issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants