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

Improve docs on Caching #966

Open
shoooe opened this issue Nov 25, 2024 · 2 comments
Open

Improve docs on Caching #966

shoooe opened this issue Nov 25, 2024 · 2 comments
Labels
help wanted Looking for assistance on this issue planned Features or content that are planned but not yet in progress. solidstart Related to SolidStart

Comments

@shoooe
Copy link

shoooe commented Nov 25, 2024

📋 Explain your issue

A common document page in other frameworks is caching. Since SolidJS just uses Nitro, caching can be easily implemented via the routeRules setting as described here: https://stackoverflow.com/q/79223996/493122

Would this be worth adding to the docs?

@shoooe shoooe added the pending review Awaiting review by team members. label Nov 25, 2024
@LadyBluenotes LadyBluenotes added help wanted Looking for assistance on this issue and removed pending review Awaiting review by team members. labels Dec 1, 2024
@brenelz
Copy link
Collaborator

brenelz commented Dec 17, 2024

Could maybe add a note here https://docs.solidjs.com/solid-start/reference/config/define-config, but I'm sure where the docs stand on nitro specific things when you could just look at things over there

@atilafassina
Copy link
Member

Yeah, we try not to document Nitro directly (because it's a slippery slope, soon we end up documenting H3, Vite, etc...) - but I believe a note to that would be helpful.

We could also add a Caching section to our Learn guide for start where we explain our deduplication system and how to leverage Nitro caching, and how to play with HTTP headers for Max-Age, SWR, etc on Server Functions (tapping into the request event and so on) - that would be super useful.

suggested action items

  • Add a explicit note about caching on the "configuring Nitro" section
  • Create a section on how to handle cache within Server Functions in SolidStart / Guides / Caching

@atilafassina atilafassina changed the title [Other]: Caching Improve docs on Caching Dec 20, 2024
@atilafassina atilafassina added planned Features or content that are planned but not yet in progress. solidstart Related to SolidStart labels Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Looking for assistance on this issue planned Features or content that are planned but not yet in progress. solidstart Related to SolidStart
Projects
None yet
Development

No branches or pull requests

4 participants