docs(pwa): clarify what Needle handles automatically + add gotchas#216
Open
kaktus-klaus wants to merge 1 commit intoneedle-tools:mainfrom
Open
docs(pwa): clarify what Needle handles automatically + add gotchas#216kaktus-klaus wants to merge 1 commit intoneedle-tools:mainfrom
kaktus-klaus wants to merge 1 commit intoneedle-tools:mainfrom
Conversation
…tion - Add "What Needle handles for you" section at the top — makes it clear that pre-caching, .gz exclusion, SPA routing, and manifest generation are all handled automatically (docs previously sounded like users had to figure all this out themselves) - Add "What to watch out for" section with practical gotchas: * First visit must be online * External/dynamic assets are not pre-cached * Large projects may want to limit globPatterns - Improve offline/kiosk section with a concrete checklist - Remove ambiguous tip about all assets being cached; integrate that information more clearly with the new structure Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
|
Collaborator
Author
|
@hybridherbst Would love your review on this PWA docs improvement when you have a moment! 🙏 |
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
1 participant
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.
Summary
Improves the PWA documentation based on feedback that it sounded like users had to handle everything themselves — when in fact Needle's plugin takes care of most of the hard parts.
Changes:
.gzfiles excluded from pre-cache (avoids bad-precaching-response 404s)globPatternsWhy
The previous docs described PWA setup without making it clear what Needle's plugin handles vs. what the developer needs to do. The impression was that users needed to handle things like .gz exclusion and SPA routing themselves, when in fact these are handled automatically.
🤖 Generated with Claude Code