Writing Documentation

Running the documentation locally

To run the documentation locally, you only need docker compose installed. Then run:

docker compose up

And you can access the documentation at http://localhost:8000.

Documentation Structure

The documentation is structured as follows:

• docs/ - contains all documentation files
• docs/guidelines/ - contains categories of guidelines, for example js and php, but also design-kit

Adding a new page

To add a new page, follow the following steps:

Create a new page

docs/guidelines/php/psr-12.md

# My Beautiful Page

Update the navigation

mkdocs.yml

nav:
  - Guidelines:
    - PHP:
      - PSR-12: "guidelines/php/psr-12.md"