Documentation (Antora)

This repository coordinates the unified documentation. It contains an Antora playbook that pulls Antora-structured documentation from the other repositories and compiles it into a static website.

Documentation Site

The published documentation is available at: https://docs.foodtrucknerdz.com

Building the Documentation

To build and preview the documentation locally:

# Install dependencies
pnpm install

# Local sibling repos: copy the example playbook, then build with local paths
cp antora-playbook-local.example.yml antora-playbook-local.yml

# Build (runs `node site/scripts/sync-antora-dark-theme.cjs` first, then Antora)
pnpm run build:local

# Or build using standard playbook (uses GitHub URLs)
pnpm run build

# Preview the site
pnpm exec http-server build/site -c-1 -p 8080

Or use the Antora Docker image:

docker run --rm -v "${PWD}:/antora" -u "$(id -u):$(id -g)" antora/antora antora-playbook.yml

Structure

This playbook coordinates documentation from multiple repositories. Each repository contains its own Antora documentation component in a docs/ folder:

• food-truck-api - Located in the food-truck-api repository (docs/)

• ftn-site - Located in the ftn-site repository (docs/). Antora component Documentation; the archived site stack is the Old website module in that repo, not a separate content source. Antora is built only from this FoodTruckNerdz/docs repository (no nested docs-site inside ftn-site).

• docs - Internal team documentation (this repository, docs/)

• help - Customer-facing help documentation (docs/)

• developer-portal - External developer API documentation (docs/)

• Standard Templates - Industry-standard project and workspace templates (available at the-dev-center/templates)

Each component contains an antora.yml descriptor file (which defines the component name and title) and its documentation pages organized in the modules/ROOT/ structure. The playbook pulls from each repository’s Git source to build the unified documentation site. Short title values used in the component switcher: ftn-site → Docs; this docs repository’s meta component → Docs site; onboarding → Onboarding; food-truck-api → API; help → Public Help Portal; developer-portal → Developer Portal.

The site/supplemental-ui/ directory holds custom Handlebars partials, CSS, and JavaScript (mast bar, sidebar tree, Outfit font, header links, breadcrumb component/version pickers, etc.). Before every build, site/scripts/sync-antora-dark-theme.cjs copies only img/ (VCS icons, etc.) from the antora-dark-theme npm package into that folder, because Antora exposes only a single ui.supplemental_files path. css/site-extra.css, css/site-doc-layout.css, partials/, and the layout scripts are maintained in this repository; merge upstream theme CSS from the package when you bump antora-dark-theme (see site/scripts/sync-antora-dark-theme.cjs). The playbook ui.bundle uses antora-supplemental/antora-dark-theme release ui-bundle.zip as the base, with these supplemental files applied on top. Playbook site.keys and footer credits are documented in Documentation Site Management (section UI bundle); the published page is docs.foodtrucknerdz.com.

Documentation Sites

• Internal Team Docs: docs.foodtrucknerdz.com - This Antora site

• Customer Help: help.foodtrucknerdz.com - Astro + Starlight (also includes Antora component)

• Developer Portal: developer.foodtrucknerdz.com - Astro + Starlight (also includes Antora component)