Skip to content

[docs] Document PWA service-worker caching behaviour + how to force-refresh #67

Description

@AnayDhawan

What problem does this solve?

StudyMap registers a service worker (public/sw.js) for offline support.
Users and contributors have no way to know the app is a PWA with a service
worker, so when a deploy ships but a device still shows old behaviour, it
reads as "the fix never happened" rather than "your browser/PWA has cached
the previous version" — exactly the confusion this came up from this week.

Proposed solution

Add a short troubleshooting doc (e.g. under /docs) explaining: StudyMap
is a PWA with offline caching, what gets cached and for how long, and the
steps to force a fresh load (hard refresh, clear site data, or
uninstall/reinstall the PWA) when something looks stale.

Alternatives considered (optional)

Could also surface an in-app "update available" toast when a new service
worker is waiting to activate, which would reduce how often manual
force-refresh steps are needed at all — separate, larger feature.

Checklist

  • I searched existing issues and this is not a duplicate.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions