Skip to content
FoodTruckNerdzPublic

About

FTN team's internal documentation

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Contributors Forks Stars Issues

Documentation (Antora)

FTN team's internal documentation hub — Antora playbook coordinating docs from multiple repositories.

Explore the docs » · Team docs · Report Bug

About The Project

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.

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

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 a thin overlay on valentus-theme (brand mark + custom footer). The playbook pins the rolling v2 ui-bundle.zip (snapshot: true). Branding uses Valentus site.keys rather than forked chrome partials. Playbook site.keys and footer credits are documented in Documentation Site Management (section UI bundle); the published page is docs.foodtrucknerdz.com.

Documentation Sites

  • Public docs hub: docs.foodtrucknerdz.com — This Antora site

  • Member-only team docs: team.docs.foodtrucknerdz.com — Sister Antora site (FoodTruckNerdz/team-docs)

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

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

(back to top)

Installation

To build and preview the documentation locally:

# Install dependencies
pnpm install

# Build (CI and local — facto-stack resolves local clones when .antora-source-id markers exist)
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

(back to top)

About

FTN team's internal documentation

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages