The simplest way to create progressive web apps across platforms and devices. Start here. This repo is home to several projects in the PWABuilder family of tools.
The documentation across PWABuilder is currently spread out across the site and our repos, and it is hard to keep track of where to go to learn about how to use packaging, the starter, the extension, and everything in between. We should unify all our documentation and make it as easy as possible for developer to find the info they need while we guide them through their entire PWA development journey.
Do you have an implementation or a solution in mind?
To avoid reinventing the wheel, we should leverage a docs solution allowing us to focus on the content and not the site. A great tool for building documentation is https://docsify.js.org/ which comes with everything we'd need to create a rich documentation resource. This resource should live under docs.pwabuilder.com
The documentation should include anything a developer would need to build their PWA, from learning about PWAs, starting new projects, converting existing projects, deploying, and publishing. We have much of this documentation wrirten in many different forms. Here is an (incomplete) potential structure for this documentation:
Start a new PWA
Getting started with PWA Starter
Prerquisites
Starter file structure
Debugging
Developing your app
Routing and Adding pages
Linting
Authenticating users
Caching
Web Notifications
Service worker
Deployment
Publish to Github pages
Publish to Azure Static Web Apps
Publish to Netlify
Publish to Vercel
Publish to AWS
PWA Studio (VS Code Extension)
Getting started with PWA Studio
Start a new PWA
Validate an existing PWA
Create/Edit Web Manifest
Create/Edit Service Worker
Generating Icons
Code snippets
Working with existing projects
PWA Starter
React
Vue
Angular
Lit
Deploy your app
Package you app
Package
What do you need to package
Manifest
Service Worker
HTTPS
Testing your app
Packaging for Windows
What do you need to generate a Windows package
Generating a Windows app package
Publishing to the Microsoft Store
packaging for Android
What do you need to generate an Android package
Generating an Android app package
Publishing to the Google Play Store
packaging for iOS
What do you need to generate an iOS package
Generating an iOS app package
Publishing to the Apple App Store
Learn about PWAs
...30 days of pwa articles
Have you considered any alternatives?
Lets use this issue to define what documentation we want to include and define the structure by editing this description
Thanks for submitting a new feature request! I've automatically added a vote 👍 reaction to help get things started. Other community members can vote to help us prioritize this feature in the future.
Tell us about your feature idea
The documentation across PWABuilder is currently spread out across the site and our repos, and it is hard to keep track of where to go to learn about how to use packaging, the starter, the extension, and everything in between. We should unify all our documentation and make it as easy as possible for developer to find the info they need while we guide them through their entire PWA development journey.
Do you have an implementation or a solution in mind?
To avoid reinventing the wheel, we should leverage a docs solution allowing us to focus on the content and not the site. A great tool for building documentation is https://docsify.js.org/ which comes with everything we'd need to create a rich documentation resource. This resource should live under docs.pwabuilder.com
The documentation should include anything a developer would need to build their PWA, from learning about PWAs, starting new projects, converting existing projects, deploying, and publishing. We have much of this documentation wrirten in many different forms. Here is an (incomplete) potential structure for this documentation:
Start a new PWA
PWA Studio (VS Code Extension)
Package
Learn about PWAs
Have you considered any alternatives?
Lets use this issue to define what documentation we want to include and define the structure by editing this description