Skip to content
This repository was archived by the owner on Sep 6, 2018. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions src/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ <h2>Overview</h2>
</a>
</div>

<div class="column">
<a href="{{ site.baseurl }}{% link venia-pwa-concept/setup/index.md %}" class="card">
<h2>Setup Venia Theme</h2>
<p>
Setup a development environment for the proof-of-concept Magento theme built using PWA Buildpack tools and Peregrine components.
</p>
</a>
</div>

<div class="column">
<a href="{{ site.baseurl }}{% link technologies/basic-concepts/index.md %}" class="card">
<h2>Basic Concepts</h2>
Expand All @@ -26,10 +35,10 @@ <h2>Basic Concepts</h2>
</div>

<div class="column">
<a href="{{ site.baseurl }}{% link pwa-buildpack/index.md %}" class="card">
<h2>PWA Buildpack</h2>
<a href="{{ site.baseurl }}{% link pwa-buildpack/project-setup/index.md %}" class="card">
<h2>Setup PWA Buildpack</h2>
<p>
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.
</p>
</a>
</div>
Expand All @@ -52,14 +61,6 @@ <h2>Peregrine UI Components</h2>
</a>
</div>

<div class="column">
<a href="{{ site.baseurl }}{% link venia-pwa-concept/index.md %}" class="card">
<h2>Venia Theme</h2>
<p>
A proof-of-concept Magento theme built using PWA Buildack tools and Peregrine components.
</p>
</a>
</div>

</div>

Expand Down
12 changes: 11 additions & 1 deletion src/pwa-buildpack/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[`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 %}
14 changes: 11 additions & 3 deletions src/venia-pwa-concept/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.
Expand All @@ -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 %}
[Peregrine]: {{ site.baseurl }}{% link peregrine/index.md %}

[Setup page]: {{ site.baseurl }}{% link venia-pwa-concept/setup/index.md %}