Publications Guide¶
The FCC framework ships 27 pre-built downloadable artifacts covering books, a comprehensive guidebook, executive presentations, academic curriculum packages, and quick-reference cards — across 5 formats (PDF, EPUB, DOCX, PPTX, HTML).
Quick Download¶
All artifacts are committed to publications/_output/ for offline clone access, and attached to GitHub Releases for direct download.
Available Artifacts (27 files, ~6 MB total)¶
Books (14 files)
| Document | Formats |
|---|---|
| Book 1: Understanding FCC (10 ch) | PDF, EPUB, DOCX, HTML |
| Book 2: Building with FCC (10 ch) | PDF, EPUB, DOCX, HTML |
| Book 3: Advanced FCC (10 ch) | PDF, EPUB, DOCX, HTML |
| FCC Guidebook (24 ch) | PDF, EPUB, DOCX, HTML |
Audience Packages (4 files)
| Package | Target Audience | Formats |
|---|---|---|
| Executive Summary | Decision Makers | PDF, DOCX |
| Academic Edition | Educators | PDF, EPUB |
Presentations (2 files)
| Deck | Formats |
|---|---|
| Executive Overview (10 slides) | PPTX, HTML (reveal.js) |
Reference Cards (5 files, all PDF)
- Persona Categories — All 20 core categories + 6 vertical packs, 147 personas
- CLI Commands — Complete
fcccommand reference - Workflow Patterns — 7 graph variants + action types
- Prompt Templates — 10 essential prompt patterns
- R.I.S.C.E.A.R. Quick Reference — 10-component specification
Building Locally¶
Prerequisites¶
- Quarto ≥ 1.5 — Install guide
- Typst — Bundled with Quarto 1.5+
- Pandoc — Bundled with Quarto 1.5+
No TeX required
The pipeline uses Typst (bundled with Quarto) for PDF generation. You do not need to install TeX Live, MiKTeX, or similar. Typst is fast (~10x faster than LaTeX) and produces professional PDFs.
One-Shot Build¶
This builds all 27 artifacts in ~3-5 minutes. Output lands in publications/_output/.
Individual Targets¶
make pub-books # Just books (~16 files, 2-3 min)
make pub-executive # Executive package + deck (4 files, <1 min)
make pub-academic # Academic package (2 files, <1 min)
make pub-reference # Reference cards (5 PDFs, <1 min)
make pub-clean # Remove _output/
Direct Script Invocation¶
Direct Quarto / Pandoc¶
cd publications
# Individual reference card
quarto render reference-cards/persona-categories.qmd --to typst
# Executive presentation
quarto render presentations/executive-overview.qmd --to pptx
# One-off book via pandoc
pandoc -f markdown-citations ../docs/books/book1_understanding_fcc/ch*_*.md \
-o my-book.pdf --pdf-engine=typst --toc --number-sections
Troubleshooting¶
"typst not found"¶
Quarto 1.5+ bundles typst. Check:
If typst is missing, reinstall Quarto or run quarto install tinytex.
"Error producing PDF" with citation errors¶
The pipeline uses -f markdown-citations to disable pandoc's citation processing (some chapters contain Python decorators like @traced that would be misinterpreted as citations). If you see citation errors, verify -f markdown-citations is present in the pandoc command.
DOCX/PPTX rendering fails¶
The pipeline requires template files at publications/templates/:
- reference.docx — generated via pandoc --print-default-data-file reference.docx > reference.docx
- presentation-reference.pptx — generated via pandoc --print-default-data-file reference.pptx > presentation-reference.pptx
If missing, regenerate them using pandoc's defaults.
Mermaid diagrams missing from PDFs¶
Mermaid diagrams render natively in HTML and Quarto's typst output. For custom pandoc-based builds, you may need to pre-render diagrams to SVG using mermaid-cli (mmdc).
Contributing to Publications¶
Adding a new chapter to an existing book¶
- Create
docs/books/bookN_*/chNN_*.mdfollowing existing chapter structure - Re-run
make pub-books - New chapter auto-included (script globs
ch*_*.md)
Creating a new reference card¶
- Create
publications/reference-cards/my-card.qmdwith YAML frontmatter: - Run
make pub-reference - PDF lands in
publications/_output/reference-cards/
Modifying Quarto book config¶
publications/_quarto.yml— Base combined book (all 3 series)publications/_quarto-executive.yml— Executive profilepublications/_quarto-academic.yml— Academic profile
Automation: GitHub Actions¶
On every new GitHub Release, the .github/workflows/publish.yml workflow automatically:
1. Installs Quarto 1.5+ via quarto-dev/quarto-actions/setup@v2
2. Runs make pub-all to build 27 artifacts
3. Uploads all artifacts to the release as downloadable assets via softprops/action-gh-release@v2
This means every future release automatically gets all publications attached — no manual upload needed.
Related Documentation¶
- Book Series Overview — All 3 books, chapter summaries
- FCC Guidebook — 24-chapter comprehensive guide
- Decision Makers Guide — Executive audience
- For Educators — Academic audience
- Reference Cards Source — .qmd source files