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

SPA.md seems to be outdated, and contradicts app-shell.md #335

Closed
JobLeonard opened this issue Jan 5, 2018 · 3 comments
Closed

SPA.md seems to be outdated, and contradicts app-shell.md #335

JobLeonard opened this issue Jan 5, 2018 · 3 comments
Labels
Milestone

Comments

@JobLeonard
Copy link

We should also specify the ServiceWorker.navigateFallbackURL, which instructs the service worker to redirect any non-cached navigation request to the specified route.

https://github.com/NekR/offline-plugin/blob/master/docs/examples/SPA.md

Previously, to achieve the same effect, ServiceWorker.navigateFallbackURL and AppCache.FALLBACK option had to be used. ServiceWorker.navigateFallbackURL is now deprecated and shouldn't be used at all. Instead, appShell should be used.

https://github.com/NekR/offline-plugin/blob/master/docs/app-shell.md

I'm not entirely sure what the correct documentation would be, but given that the SPA one is older I assume it's the outdated one. Since it is the first and only linked example from the README.md, this can lead people astray.

@NekR
Copy link
Owner

NekR commented Jan 5, 2018

Indeed! It's outdated and should be updated, thanks for pointing to it!

@NekR NekR added the docs label Jan 5, 2018
@NekR NekR added this to the 5.0 milestone Mar 8, 2018
@NekR
Copy link
Owner

NekR commented Mar 8, 2018

Would be great to have this for v5 release if navigateFallbackURL option is going to be removed.

@JobLeonard
Copy link
Author

Yes it would!

But as much as I'd like to help out, I'm afraid I can't in practice, since the issue is about documentation for changes in the code and API that I don't know about because it's not consistently documented :P

I guess I can proofread though.

@NekR NekR closed this as completed in abdae89 Apr 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants