Skip to content

Commit ba023f9

Browse files
committed
Added user doc
1 parent 31bb969 commit ba023f9

8 files changed

Lines changed: 349 additions & 199 deletions

File tree

.agents/skills/external/ibexa-documentation/SKILL.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
11
---
22
name: ibexa-documentation
3-
description: Find answers in the locally installed Ibexa DXP developer documentation. Use when working on an Ibexa DXP project and you need to look up how a feature, API, configuration, or extension point works.
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.
44
---
55

6-
# Ibexa DXP developer documentation
6+
# Ibexa DXP documentation
77

88
<!-- Placeholder skill: shipped with ibexa/documentation-developer, content to be expanded. -->
99

10-
The full Ibexa DXP developer documentation is installed locally in
11-
`vendor/ibexa/documentation-developer/`.
10+
The full Ibexa DXP documentation is installed locally in
11+
`vendor/ibexa/documentation-developer/`:
12+
13+
- `developer/` — developer documentation: APIs, extension points,
14+
configuration, tutorials.
15+
- `user/` — user documentation: back office, content management, commerce
16+
workflows.
1217

1318
## Finding a topic
1419

15-
1. Read `vendor/ibexa/documentation-developer/llms.txt` — the table of contents
16-
for the whole documentation, grouped by section, with relative links into `doc/`.
17-
2. Or search directly: `grep -ri "<topic>" vendor/ibexa/documentation-developer/doc/`.
18-
3. Follow the relative links between pages; they all work offline.
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.
1928

2029
## Conventions
2130

22-
- One page per directory: `doc/<section>/.../<page>/index.md`.
31+
- One page per directory: `<set>/<section>/.../<page>/index.md`.
2332
- PHP API references are links to the class source in `vendor/`, with the fully
2433
qualified class name as the link text. If the target file doesn't exist, that
2534
package isn't installed in this project — the class name still tells you what

.gitattributes

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/* export-ignore
22
/.agents export-ignore=false
3-
/doc export-ignore=false
4-
/llms.txt export-ignore=false
3+
/developer export-ignore=false
4+
/user export-ignore=false
55
/composer.json export-ignore=false
66
/LICENSE export-ignore=false
77
/README.md export-ignore=false

.github/workflows/release_composer_package.yaml

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,13 @@ jobs:
4545
with:
4646
ref: ${{ matrix.branch }}
4747

48+
- name: Check out user documentation
49+
uses: actions/checkout@v4
50+
with:
51+
repository: ibexa/documentation-user
52+
ref: ${{ matrix.branch }}
53+
path: user-docs
54+
4855
- name: Set up Python
4956
uses: actions/setup-python@v3
5057
with:
@@ -53,7 +60,7 @@ jobs:
5360
- name: Install dependencies
5461
run: |
5562
python -m pip install --upgrade pip
56-
pip install -r requirements.txt
63+
pip install -r requirements.txt -r user-docs/requirements.txt
5764
5865
- name: Setup PHP
5966
uses: shivammathur/setup-php@v2
@@ -84,13 +91,17 @@ jobs:
8491
with:
8592
dependency-versions: highest
8693

87-
- name: Build documentation
94+
- name: Build developer documentation
95+
run: mkdocs build --strict
96+
97+
- name: Build user documentation
8898
run: mkdocs build --strict
99+
working-directory: user-docs
89100

90101
- name: Resolve PHP API classes to vendor paths
91-
run: php tools/llm_package/dump_class_paths.php site class_paths.json
102+
run: php tools/llm_package/dump_class_paths.php site user-docs/site class_paths.json
92103

93-
- name: Build package Markdown (doc/, llms.txt)
104+
- name: Build package Markdown (developer/, user/)
94105
run: python build_package_docs.py --version "${{ matrix.branch }}"
95106

96107
- name: Copy package README
@@ -118,15 +129,15 @@ jobs:
118129
run: |
119130
# The generated Markdown is never committed/pushed to the branch itself (only
120131
# tagged), so there's nothing on the branch to diff against — compare the freshly
121-
# built content to what the last tag captured instead. -f because doc/ and
122-
# llms.txt are gitignored to keep local builds out of the working tree.
123-
git add -f doc llms.txt
132+
# built content to what the last tag captured instead. -f because developer/ and
133+
# user/ are gitignored to keep local builds out of the working tree.
134+
git add -f developer user
124135
git add README.md
125136
if [[ -z "$LATEST_TAG" ]]; then
126137
echo "changed=true" >> "$GITHUB_OUTPUT"
127138
# .agents (agent skills, tracked on the branch) is part of the package too;
128139
# include it so skill-only edits also produce a release.
129-
elif git diff --cached --quiet "$LATEST_TAG" -- doc llms.txt README.md .agents; then
140+
elif git diff --cached --quiet "$LATEST_TAG" -- developer user README.md .agents; then
130141
echo "changed=false" >> "$GITHUB_OUTPUT"
131142
else
132143
echo "changed=true" >> "$GITHUB_OUTPUT"

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,7 @@ code_samples/_inline_php/
2323
*.egg-info/
2424
/doc/
2525
/llms.txt
26+
/developer/
27+
/user/
2628
/class_paths.json
29+
/user-docs/

0 commit comments

Comments
 (0)