Missing proper 'Get started' docs
kwikwag opened this issue · comments
Library Affected:
General
Browser & Platform:
All
Issue or Feature Request Description:
Sort of a feature request: the README points to workbox/guides/get-started
which redirects to workbox/the-ways-of-workbox
which begins with a rather esoteric discussion about generateSW
and injectManifest
. Even in the main landing page for Workbox it's unclear where to start. The closest thing to an entry point seems to be the paragraph mentioning workbox-cli
but there is simply no page guiding a user into installing and integrating Workbox into their framework.
The following paragraph should probably be at the top:
If you're looking for the lowest possible barrier to entry with Workbox, the CLI is for you:
npm install workbox-cli --save-dev
To start using the CLI, run the wizard with
npx workbox wizard
.
Hi, @kwikwag, thanks for the report!
PRs are always welcome, though they probably won't be merged anytime soon. It looks like there isn't anyone with write access left on the team: the last commit was 7 months ago. All we can really do right now is wait.🤷
Hello all,
I would definitely love to work with you guys for all the documentation work, Please let me know how I can help you.
Thank you
Hi there,
Workbox is moving to a new engineering team within Google. As part of this move, we're declaring a partial bug bankruptcy to allow the new team to start fresh. We realize this isn't optimal, but realistically, this is the only way we see it working. For transparency, here're the criteria we applied:
- For PRs, we closed everything that doesn't target the current
v7
branch. - For Issues, we closed everything that was created before 2024.
Thanks, and we hope for your understanding!
The Workbox team