This repository is used to store the code for the Commerce Admin Developer documentation website. It is built using the Adobe Edge Delivery Services and deployed to Adobe Developer.

This site contains the latest Adobe Commerce and Magento Open Source developer documentation for ongoing releases, including design patterns, style guides, and best practices for Admin UI development.

Contributors

Our goal is to provide the Adobe Commerce and Magento Open Source communities with comprehensive and quality technical documentation. We believe that to accomplish that goal we need experts from the community to share their knowledge with us and each other. We are thankful to all of our contributors for improving the documentation.

See the Contribution Guide for details about contributing to Adobe Commerce and Magento Open Source developer documentation.

Quick start

For local development, you need to start three servers:

1. Content server (your content repo):

   This starts the content server on port 3003.

2. Code server (adp-devsite):

   git clone https://github.com/AdobeDocs/adp-devsite
   cd adp-devsite
   npm install
   npm run dev

3. Runtime connector (devsite-runtime-connector):

   git clone https://github.com/aemsites/devsite-runtime-connector
   cd devsite-runtime-connector
   npm install
   npm run dev

Once all three servers are running, navigate to http://localhost:3000/<pathPrefix>

For common utilities and documentation, please see the centralized README.

Testing and linting

Markdown linting

To lint your markdown files before pushing, execute:

To automatically fix linting errors, execute:

Content validation

To check internal and external links, validate front matter and more, execute:

TOC validation

To validate the table of contents (TOC) file, execute:

If you have questions, open an issue and ask us. We look forward to hearing from you!