|
1 | 1 | --- |
2 | 2 | name: ibexa-documentation |
3 | | -description: Find answers in the locally installed Ibexa DXP documentation (developer and user docs). Use when working on an Ibexa DXP project and you need to look up how a feature, API, configuration, extension point, or back-office workflow works. |
| 3 | +description: Look up features, concepts, configuration, extension points, and back office workflows in the locally installed Ibexa DXP documentation. Use whenever working on an Ibexa DXP project and you need to know how something in Ibexa works before writing code, configuration, or answers. |
4 | 4 | --- |
5 | 5 |
|
6 | 6 | # Ibexa DXP documentation |
7 | 7 |
|
8 | | -<!-- Placeholder skill: shipped with ibexa/documentation-developer, content to be expanded. --> |
| 8 | +The official Ibexa DXP documentation is installed as Markdown files in `vendor/ibexa/documentation-developer/`. |
| 9 | +It matches this project's Ibexa DXP release line (e.g. 5.0). |
| 10 | +Always consult it before web searches or memory: it works offline, matches the installed version, and links directly to the code in `vendor/`. |
9 | 11 |
|
10 | | -The full Ibexa DXP documentation is installed locally in |
11 | | -`vendor/ibexa/documentation-developer/`: |
| 12 | +It contains two documentation sets: |
12 | 13 |
|
13 | | -- `developer/` — developer documentation: APIs, extension points, |
14 | | - configuration, tutorials. |
15 | | -- `user/` — user documentation: back office, content management, commerce |
16 | | - workflows. |
| 14 | +- `developer/` — APIs, configuration, extension points, tutorials. Mirrors https://doc.ibexa.co/en/latest/ |
| 15 | +- `user/` — back office, editorial and commerce workflows. Mirrors https://doc.ibexa.co/projects/userguide/en/latest/ |
17 | 16 |
|
18 | | -## Finding a topic |
| 17 | +Use the documentation for what the code cannot tell you: |
19 | 18 |
|
20 | | -1. Read the set's table of contents: |
21 | | - `vendor/ibexa/documentation-developer/developer/llms.txt` or |
22 | | - `vendor/ibexa/documentation-developer/user/llms.txt` — grouped by section, |
23 | | - with relative links. |
24 | | -2. Or search directly: |
25 | | - `grep -ri "<topic>" vendor/ibexa/documentation-developer/developer/`. |
26 | | -3. Follow the relative links between pages (including cross-links between the |
27 | | - developer and user docs); they all work offline. |
| 19 | +- Concepts and the content model: content types, fields, locations, |
| 20 | + versions, languages, and how they relate. |
| 21 | +- Release notes and changes between versions: `developer/release_notes/`. |
| 22 | +- Update and migration instructions: `developer/update_and_migration/`. |
| 23 | +- Project and feature setup, configuration, and best practices: `developer/infrastructure_and_maintenance/`. |
| 24 | + |
| 25 | +For method signatures and contracts, the code in `vendor/` is authoritative. |
| 26 | +Use the documentation for the intent, concepts, and configuration around them. |
| 27 | +When the documentation and the installed code don't match, the code is right. |
| 28 | + |
| 29 | +## Finding topics |
| 30 | + |
| 31 | +- Read the set's table of contents: `vendor/ibexa/documentation-developer/developer/llms.txt` (or `user/llms.txt`). Page titles are grouped by section, with relative links. |
| 32 | +- Search the sets directly: `grep -ril "<topic>" vendor/ibexa/documentation-developer/`. |
28 | 33 |
|
29 | 34 | ## Conventions |
30 | 35 |
|
31 | | -- One page per directory: `<set>/<section>/.../<page>/index.md`. |
32 | | -- PHP API references are links to the class source in `vendor/`, with the fully |
33 | | - qualified class name as the link text. If the target file doesn't exist, that |
34 | | - package isn't installed in this project — the class name still tells you what |
35 | | - to look for. |
36 | | -- Prefer the documentation matching this project's installed version; this |
37 | | - package is versioned together with Ibexa DXP. |
| 36 | +- Links between pages are relative and work offline. Follow them for related topics. |
| 37 | +- PHP API references link to the class source in this project's `vendor/` directory. If the target file doesn't exist, that package isn't installed. |
| 38 | + |
| 39 | +## Keep documentation up to date |
| 40 | + |
| 41 | +The package is versioned as `MAJOR_DXP_VERSION.MINOR_DXP_VERSION.DATE_OF_TAGGING_YYYYMMDD` and must be used with the matching Ibexa DXP release line. |
| 42 | +For example, `5.0.20260101` is for Ibexa DXP 5.0.x releases. |
| 43 | +New version is released when the documentation content is updated. |
| 44 | + |
| 45 | +To check whether the documentation contains all the latest updates, run: |
| 46 | + |
| 47 | +``` bash |
| 48 | +composer outdated --direct "ibexa/documentation-*" |
| 49 | +``` |
| 50 | + |
| 51 | +To update it, run: |
| 52 | + |
| 53 | +```bash |
| 54 | +composer update ibexa/documentation-developer --no-scripts |
| 55 | +``` |
| 56 | + |
| 57 | +Always pass `--no-scripts`: the package contains only Markdown files, so the slow post-update scripts (cache clear, asset and frontend builds) are unnecessary. |
0 commit comments