Build Docs

This documentation was generated with the assistance of AI. Please report any inaccuracies.

Build a repository’s existing Antora documentation site as-is, scaffolding it first via iru-setup-antora if it doesn’t exist yet. This skill never edits page content, nav.adoc, or antora.yml beyond what bootstrapping requires — it only ensures the toolchain/module exist and runs the build.

Purpose

iru-build-docs answers a narrower question than iru-update-docs: "does the docs site build right now?" rather than "does the docs site reflect recent code changes?". It does no code exploration and makes no content edits to any existing page — it locates the Antora module, confirms Node.js and the playbook are usable, installs dependencies, and runs the build, reporting the built index.html path or the exact build error. Reach for it to check the site compiles or to get the built HTML output, not to bring stale content up to date.

Purpose group

Repository Maintenance

Invocation

/iru-build-docs

Inputs

None — no arguments are accepted or needed.

Outputs

  • The static site built at the docs module’s build output directory (e.g. docs/build/site), with the path to its index.html reported back.

  • If no Antora module existed anywhere in the repository and the user agreed to bootstrap one: a newly scaffolded Antora module (via iru-setup-antora), then the build proceeds against it.

  • No .adoc page content, nav.adoc, or antora.yml is ever edited by this skill itself (only iru-setup-antora, when delegated to, may write those as part of scaffolding).

  • A report stating whether the module already existed or was just set up, whether the build succeeded or failed, and the path to the built index.html or the build error — nothing else.

Execution flow

flowchart TD A[Start /iru-build-docs] --> B[Search repo for antora.yml files] B --> C{Any antora.yml found?} C -- no --> D[Ask user whether to\nbootstrap docs now] D -- declines --> D1[Stop: nothing to build] D -- agrees --> E["Run setup-antora"] E --> F{setup-antora stopped short?\ne.g. Node.js missing} F -- yes --> F1[Relay blocker; stop] F -- no --> G C -- yes --> G["Locate playbook file;\nconfirm Node.js/npm usable"] G --> H{Node.js usable?} H -- no --> H1[Stop; point at setup-antora's\ninstall instructions] H -- yes --> I["npm ci (or npm install\nif no lockfile) && npx antora <playbook>"] I --> J{Build succeeds?} J -- yes --> K[Report built index.html path] J -- no --> L[Report Antora/Asciidoctor error verbatim;\nno content fix attempted]

Dependencies

Invokes

  • Setup Antora — Step 1, conditionally: only when no antora.yml is found anywhere in the repository, and only after asking the user whether to bootstrap Antora documentation now.

Invoked by

None — meant to be run directly by a person who just wants the docs site built or verified, independent of the /iru-code or /iru-issue flows.

Related agents

None.

Source

SKILL.md on GitHub — the file this page was generated from.