ndzoesch / shopware-docs

Shopware 6 developer docs

nav
hidden true

Shopware Developer Documentation

This repository contains general developer documentation for Shopware 6 which is served on developer.shopware.com/docs. However, the primary hub for all our developer resources is managed through the developer portal repository. The developer documentation is organized into sections covering :

• Concepts
• Guides
• Products
• Resources

Refer to its structure to understand better. Contributions to improve the content are welcome, following the outlined contribution guidelines. The markdown content undergoes workflow checks for easier maintenance. Further details are outlined below.

Workflows

They are defined in the .github/workflows folder and help the DX team to maintain the documentation. The workflows are triggered by events like push, pull_request, schedule and workflow_dispatch. The workflows are used to build, test, and deploy the documentation. If a PR pipeline fails, the PR will be marked as failed, and it won't be possible to merge it. In this case, check the below-mentioned workflows to see what went wrong and where to fix it.

Grammar and language check

All changed content is checked with Reviewdog for grammar and language. The configuration for Reviewdog can be found in .reviewdog.yml. It will create warnings in the pull request if the language or grammar is not correct. A more in-depth explanation can be found in Language and Grammar section.

Markdown check

The markdown files are checked with markdown-lint to identify issues such as formatting errors, style inconsistencies, etc. By doing so, it facilitates the creation of well-structured and consistent Markdown documents.. The configuration for markdown-lint can be found in markdown-style-check.yml.

Spellcheck

The markdown files are checked with py-spelling to rectify spelling errors. The configuration for py-spelling can be found in .spellcheck.yml. To exclude a word from being spellchecked, add it to the .wordlist.txt file. Make sure to add the word at the right position, as the file doesn't automatically sort alphabetically. You can use the following command to sort the file:

sort .wordlist.txt -o .wordlist.txt

Media file format check

The /docs/assets folder stores images, videos, and other files linked in markdown. They follow the naming convention outlined in Methodize Assets. The file-format-check.yml ensures adherence to these naming guidelines.

External link check

Lychee is used to check if external links are working properly or broken. The configuration for lychee can be found in validate-external-links.yml.

Synced files

Certain files within the shopware/shopware repository are duplicated in the shopware/docs repository for reference purposes. Any modifications made to the former files will automatically synchronize with the corresponding files in the latter repository by the update-adrs workflow.

shopware/shopware files	shopware/docs files
shopware's adr	adr folder
adr assets	assets adr folder
coding guideline	core

Please create a PR in the shopware repository if you want to change something in the above folders.