Ibexa DXP Developer Documentation

This repository is the source for the developer documentation for Ibexa, a digital experience platform that is based on the Symfony Full Stack Framework in PHP.

Resources

1. Ibexa DXP Developer Hub: https://developers.ibexa.co
2. Ibexa DXP Repository: https://github.com/ibexa/oss
3. Ibexa Website: https://ibexa.co
4. User documentation: https://doc.ibexa.co/projects/userguide

How to contribute

To contribute to the documentation, you can open a PR in this repository.

If you'd like to see Ibexa DXP in your language, you can contribute to the translations.

Contribute to API reference

The REST API Reference is located in the docs/api/rest_api/rest_api_reference/ directory. It is based on an OpenAPI specification (openapi.yaml / openapi.json) generated from the Ibexa DXP source code. To contribute to the REST API reference, you must modify the source code annotations directly.

Build and preview documentation

To build and preview your changes locally, you need to install Python along with its package manager (pip). Other required tools will be installed by using the following command:

pip install -r requirements.txt

Then you can run:

mkdocs serve

After a short while your documentation should be reachable at http://localhost:8000. If it isn't, check the output of the command.

Testing the code samples

markdownlint

This repository uses markdownlint-cli2 to check Markdown formatting, including table syntax.

Install dependencies:

yarn install

Run the linter:

yarn markdownlint

Some issues can be fixed automatically:

yarn markdownlint --fix

PHPStan

This repository uses PHPStan to test the code samples. To run the tests locally execute the commands below:

composer update
composer phpstan

Regenerate the baseline by running:

composer phpstan -- --generate-baseline

Deptrac

This repository uses Deptrac to test the code samples. To run the tests locally execute the commands below:

composer update
composer deptrac

Regenerate the baseline by running:

vendor/bin/deptrac --formatter=baseline

Where to View

https://doc.ibexa.co