docs: describe available caching strategies#2489
Draft
Maciek Kucmus (mkucmus) wants to merge 2 commits into
Draft
docs: describe available caching strategies#2489Maciek Kucmus (mkucmus) wants to merge 2 commits into
Maciek Kucmus (mkucmus) wants to merge 2 commits into
Conversation
Maciek Kucmus (mkucmus)
added
the
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new “Caching” best-practices page documenting the caching layers available in Shopware Frontends, and wires it into the docs navigation so it’s discoverable.
Changes:
- Added
best-practices/caching.mdcovering request (cacheableReads), render (routeRules), edge/CDN, backend HTTP cache, client state, and assets/images caching. - Linked the new page from Best Practices landing page (
PageRef) and from the VitePress sidebar. - Extended
AGENTS.mdwith a concise caching reference for contributors making code changes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| apps/docs/src/best-practices/index.md | Adds a Best Practices card linking to the new caching page. |
| apps/docs/src/best-practices/caching.md | New documentation page describing caching strategies across multiple layers. |
| apps/docs/.vitepress/sidebar.ts | Adds “Caching” entry under BEST PRACTICES in the sidebar. |
| AGENTS.md | Adds a “Caching” section summarizing request/render/client-state caching guidance for contributors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes: #1631
What
New docs page
best-practices/caching.mddescribing the caching strategies available in Shopware Frontends.Covers six layers:
cacheableReads) - opt-in POST->GET Store API reads with compressed_criteria, incl. the GET-over-POST architectural rationale, covered vs POST-only composables, andencodeForQueryencoding.routeRules) - ISR/SWR/prerender/headers with the real template examples.Cache-Control, context scoping (sw-context-hash/Vary), reverse proxy.shopware@nuxt/imageprovider + presets.