FoodTruckNerdz Documentation

This repository coordinates the documentation for all FoodTruckNerdz projects. 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

The Antora documentation site files are located in the site/ folder.

To build and preview the documentation locally:

# Navigate to the site folder
cd site

# Install dependencies
pnpm install

# Build using local playbook (for local development)
pnpm exec antora antora-playbook-local.yml

# Or build using standard playbook (uses GitHub URLs)
pnpm exec antora antora-playbook.yml

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

Or use the Antora Docker image:

cd site
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/)

• ftn-site-old - Located in the ftn-site-old repository (docs/)

• 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 its documentation pages organized in the modules/ROOT/ structure. The playbook pulls from each repository’s Git source to build the unified documentation site.

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)