Updated documentation based on user research/feedback

[ericerway]

This issue is for the following packages:

[ ] venia-concept [ ] pwa-buildpack [ ] peregrine [ ] pwa-module [X] pwa-devdocs

Description

Minor content updates throughout PWADocs to improve onboarding, setup and configuration for new developers based on feedback at recent Magento U training in Austin.

Assumptions

• Refer to summary from UX and @soumya-ashok
• Dependencies on Venia and Studio code examples from team

Tasks

• [x] Review user research/feedback with UX for opportunities
• [x] Updates as appropriate throughout PWADocs and identify new stories (as appropriate)

Devdocs Tasks

• [ ] Enable the terms "pwa", "progressive web apps", "venia", "pwa theme" etc. to result in matches from dev docs site search no matter which version of Magento they have in the top dropdown On https://devdocs.magento.com/guides/v2.3/pwa/
• [x] Start page with basic definition of a PWA and provide an external link to Google PWA documentation for more details
• [x] Follow this with basic details on Magento PWA, remove links to individual tools/repos
• [x] Highlight link to the Magento PWA Documentation Site

PWA docs site homepage tasks:

• [x] Add a gray bottom border for the top nav container
• [x] Modify the text in the top blue bar to read "Content on the site will follow the progress of the Magento PWA project. Questions, concerns or just want to chat? Join us on the Community Engineering PWA Slack workspace (Link to: https://magentocommeng.slack.com/messages/C71HNKYS2)
• [x] Add a link to the footer for the Slack channel as well
• [x] Relabel "Learn Peregrine UI Components" to "UI Components (Peregrine)"
• [x] Change headings of text blurbs above the footer to read :"Buildpack Source", "UI Components (Peregrine) Source and "Venia Theme Source"
• [x] For the text under "Venia Theme Source" make it clear that this is a starter theme that can be customized

PWA setup topic tasks: On https://magento-research.github.io/pwa-studio/venia-pwa-concept/setup/

• [x] Change page header to read "Venia Theme Setup"
• [ ] Restructure the top of this page to list pre-requisites first with a link to the instructions for Magento setup
• [x] Follow with Venia Theme setup instructions
• [x] Change heading "Vagrant Box Instructions" to "Magento Installation"
• [x] Under that, text structured "You need to have Magento installed, and you can use the following methods to do that. If you used a Vagrant Box, then this is how you would setup the Venia theme If you used Valet or ValetPlus, this is how you would setup the Venia theme If you used method C....and so on
• [x] Change “At the end of this tutorial, you will have the Venia theme project installed in Magento 2 and a local development environment set up.” to “If you have a local development environment of Magento set up, the instructions here will tell you how to install a working copy of the Venia PWA theme”

Peregrine docs tasks:

• [ ] Compilation of common Venia theme setup errors and how to resolve them
• [ ] "Peregrine Documentation" link in the readme goes to the old site, this link needs to be updated
• [x] Old pwa-devdocs site needs to be deleted
• [ ] The Peregrine overview page could use more content, it appears incomplete to readers
• [x] In the 'UI components' section, change the left nav heading from "Components Reference" to "Components"

General:

• [ ] Troubleshooting guide for installation, use etc.
• [ ] A "last updated" marker on the site?
• [ ] Add topics that explain our directory structure and how to navigate "Demystifying Venia"

[ericerway]

Kamino cloned this issue to magento-research/pwa-studio

[ericerway]

Marking partially complete for Sprint 24. Splitting and moving remaining tasks to Sprint 25. Thanks!