Skip to content

Commit 1463c17

Browse files
committed
docs(antora): expand local playbook example; add docs source to CI playbook
- antora-playbook-local.example.yml: header with copy/setup steps, sibling clone layout, and site.keys comments aligned with main playbook - antora-playbook.yml: include FoodTruckNerdz/docs.git so start_page docs:: and the Docs component resolve when building from GitHub Actions Made-with: Cursor
1 parent 7fdd2c6 commit 1463c17

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

antora-playbook-local.example.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
# Local Antora playbook template
2+
#
3+
# 1. Copy this file to antora-playbook-local.yml (gitignored; see .gitignore).
4+
# 2. From the docs repo root: pnpm dlx antora antora-playbook-local.yml
5+
#
6+
# Clone sibling repos next to docs/ (same parent folder names as below):
7+
# onboarding, food-truck-api, ftn-site, ftn-app, help, developer-portal
8+
#
9+
# Content source order matches antora-playbook.yml except URLs are relative
10+
# and this repo is url: . instead of the GitHub docs.git URL.
11+
112
site:
213
title: Documentation
314
url: https://docs.foodtrucknerdz.com
@@ -6,8 +17,10 @@ site:
617
site_description: "Multi-component Antora site (unified project documentation)"
718
github_profile_url: "https://github.com/FoodTruckNerdz"
819
foodtrucknerdz_com: "https://foodtrucknerdz.com"
20+
# Shown in footer; match ui.bundle below (becomes site.keys.uiBundle* in the UI model).
921
ui_bundle_name: "antora-dark-theme"
1022
ui_bundle_url: "https://github.com/antora-supplemental/antora-dark-theme"
23+
# Browser tab (head-title partial): last segment; middle = each component’s antora.yml `title`.
1124
title_bar_brand: "Food Truck Nerdz"
1225
content:
1326
sources:

antora-playbook.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ content:
2525
- url: https://github.com/FoodTruckNerdz/ftn-app.git
2626
branches: HEAD
2727
start_path: docs
28+
- url: https://github.com/FoodTruckNerdz/docs.git
29+
branches: HEAD
30+
start_path: docs
2831
- url: https://github.com/FoodTruckNerdz/help.git
2932
branches: HEAD
3033
start_path: docs

0 commit comments

Comments
 (0)