diff --git a/src/index.html b/src/index.html index b3f4d6f..885878e 100644 --- a/src/index.html +++ b/src/index.html @@ -16,6 +16,15 @@

Overview

+
+ +

Setup Venia Theme

+

+ Setup a development environment for the proof-of-concept Magento theme built using PWA Buildpack tools and Peregrine components. +

+
+
+

Basic Concepts

@@ -26,10 +35,10 @@

Basic Concepts

- -

PWA Buildpack

+
+

Setup PWA Buildpack

- Build and development tool for Magento PWA projects. Set up and configure your local environment for PWA development. + Build and development tool for Magento PWA projects. Learn to set up and configure your local environment for PWA development.

@@ -52,14 +61,6 @@

Peregrine UI Components

-
- -

Venia Theme

-

- A proof-of-concept Magento theme built using PWA Buildack tools and Peregrine components. -

-
-
diff --git a/src/pwa-buildpack/index.md b/src/pwa-buildpack/index.md index 2843517..2b9425a 100644 --- a/src/pwa-buildpack/index.md +++ b/src/pwa-buildpack/index.md @@ -5,6 +5,16 @@ title: PWA Buildpack PWA Buildpack is a build and development tool and library for Magento Progressive Web Apps. Use the PWA Buildpack project to set up and configure your local environment for PWA development. +## Setup + +Follow the [Project setup tutorial] to set up a PWA development environment. + +If you are having trouble setting up your environment, see the [Troubleshooting page]. + +## Contribute + Visit the [`pwa-buildpack`] repository to contribute to this project. -[`pwa-buildpack`]: https://github.com/magento-research/pwa-buildpack \ No newline at end of file +[`pwa-buildpack`]: https://github.com/magento-research/pwa-buildpack +[Project setup tutorial]: {{ site.baseurl }}{% link pwa-buildpack/project-setup/index.md %} +[Troubleshooting page]: {{ site.baseurl }}{% link pwa-buildpack/troubleshooting/index.md %} \ No newline at end of file diff --git a/src/venia-pwa-concept/index.md b/src/venia-pwa-concept/index.md index 3ee24ca..5e40b8b 100644 --- a/src/venia-pwa-concept/index.md +++ b/src/venia-pwa-concept/index.md @@ -5,9 +5,15 @@ title: Venia Theme (Concept) The Venia theme is a proof-of-concept Magento theme built using [PWA Buildpack] tools and [Peregrine] components. In its current, experimental state, the theme contains examples for Product Details and Category pages. +## Setup development environment + +Follow the directions on the [Setup page] to set up development environment for the Venia Theme. + +## Module and theme directories + The [`venia-pwa-concept`] project itself contains a module and theme. -## PWA module +### PWA module The `module` directory contains the code for a helper module for all Magento PWA Studio themes. This module provides the following server-side functionality: @@ -16,7 +22,7 @@ This module provides the following server-side functionality: * Assigns a `RootComponent` to an entity or group of entities without requiring a deployment. (**In development**) * Embeds GraphQL payloads into the initial server render without requiring a round trip to the API after the web app has initialized on the client side. (**In development**) -## Venia theme +### Venia theme The `theme-frontend-venia` directory contains the code for the Venia theme itself. This directory contains the files required for a Magento theme along with files that define pages and components. @@ -27,4 +33,6 @@ Visit the [`venia-pwa-concept`] repository to contribute to the development of t [`venia-pwa-concept`]: https://github.com/magento-research/venia-pwa-concept [PWA Buildpack]: {{ site.baseurl }}{% link pwa-buildpack/index.md %} -[Peregrine]: {{ site.baseurl }}{% link peregrine/index.md %} \ No newline at end of file +[Peregrine]: {{ site.baseurl }}{% link peregrine/index.md %} + +[Setup page]: {{ site.baseurl }}{% link venia-pwa-concept/setup/index.md %} \ No newline at end of file