Skip to content

Commit 2349ab9

Browse files
committed
Documentation building skill
1 parent 04e139d commit 2349ab9

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: documentation-build
3+
description: >
4+
How to build, preview, and incrementally rebuild the Quarkus documentation
5+
site locally using Maven, sync scripts, and a containerized Jekyll server.
6+
---
7+
8+
# Documentation Build
9+
10+
## Full Build
11+
12+
Build the entire documentation (from the repository root):
13+
14+
```bash
15+
mvn clean install -DskipTests -Denforcer.skip -Dcheckstyle.skip -DskipITs=true -Dmaven.javadoc.skip=true
16+
```
17+
18+
## Preview
19+
20+
From the `docs/` directory, sync the generated site:
21+
22+
```bash
23+
cd docs/
24+
./sync-web-site.sh
25+
```
26+
27+
Then start a local Jekyll server with Podman:
28+
29+
```bash
30+
podman run -p 4000:4000 -v "$(pwd)/target/web-site:/site:z" bretfisher/jekyll-serve
31+
```
32+
33+
The site is available at `http://localhost:4000`.
34+
35+
## Incremental Rebuild
36+
37+
While the preview container is running, rebuild changed docs without a full
38+
clean build:
39+
40+
```bash
41+
mvn package -Dno-build-cache
42+
```
43+
44+
Then re-run `./sync-web-site.sh` in `docs/` to pick up the changes. The Jekyll
45+
server auto-reloads updated files.

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,3 +98,4 @@ Consult the relevant skill when you are about to do that type of work:
9898
| `coding-style` | Code formatting, visibility, naming conventions, and logging |
9999
| `building-and-testing` | Maven build commands, flags, incremental builds, and build rules |
100100
| `pull-requests` | PR title/description conventions, commit hygiene, labels, and contribution rules |
101+
| `documentation-build` | Building, previewing, and incrementally rebuilding the documentation site locally |

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ guidance before starting work:
2323
when building, testing, or understanding Maven flags and build commands.
2424
- **Pull requests** — Read `.agents/skills/pull-requests/SKILL.md`
2525
when preparing a pull request, writing commit messages, or choosing labels.
26+
- **Documentation build** — Read `.agents/skills/documentation-build/SKILL.md`
27+
when building, previewing, or rebuilding the documentation site locally.

0 commit comments

Comments
 (0)