Skip to content

Latest commit

 

History

History
58 lines (46 loc) · 4.85 KB

README.md

File metadata and controls

58 lines (46 loc) · 4.85 KB

Shopware Developer Portal

Build and deploy Issues Pull Requests Website License Open in GitHub Codespaces

Team DX is serving the teams to provide documentation to our customers.

Shopware has its history of creating and maintaining self-build and self-hosted documentations, which went wild after the initial deployment, because there was no dedicated "owner" who directly maintained the docs and fixed bugs etc.

We want to make it easy for everyone to set up and maintain / preview / deploy the new documentation and have a dedicated "ownership" so people have less to worry about. Ultimately - we want the majority of teams to adopt that approach, not being force into. 🙂

This repository:

Note: This repository does not include layouts, templates and other components - these are provided by the developer-documentation-vitepress.

Setup

See QUICK START for more info on how to start using Developer Portal, including some basic examples on how to embed and manage docs repos, and preview the dev and prod builds.

For a ready-to-code example, see DevContainer powered by GitHub Codespaces, VSCode Dev Container or similar solution.

Table of contents

Section Description
Quick start Set up your local Developer portal instance and start using CLI
CLI In-depth description for all features provided by the Shopware Docs CLI
Features In-depth description for all features provided by thedeveloper-documentation-vitepres
Features (external) In-depth description for all features provided by the developer-documentation-vitepress
Tests Walkthrough for tests
FAQ Frequently asked questions
DevContainer Using Shopware Docs with DevContainer