Skip to main content
Firmware Stable

Composite Product Manuals

This folder contains self-contained product manuals that combine hardware specifications, firmware configuration, and software connectivity into a single linear document.

Purpose​

The main documentation site (Docusaurus) is structured as interlinked pages -- great for browsing, but some customers prefer a single PDF they can print or send to their integration team. Composite manuals serve that need.

Structure​

composite/
  build_pdf.mjs       -- Shared build script (takes manual folder as argument)
  style.css           -- Shared PDF stylesheet
  package.json        -- Shared dependencies (puppeteer, marked, mermaid)
  node_modules/       -- Installed deps (not committed)
  silixcon-logo.png   -- Brand logo (copied into manuals at build time)
  silixcon-logo.svg
  build/              -- PDF output directory (git-ignored)
  README.md
  SKILL.md            -- Agent skill for creating new manuals
  Raptor-C_FALCON_Manual/
    index.md          -- Full manual source (Markdown)
    manual.json       -- Cover page config (title, subtitle, image, version)
    img/              -- Product-specific images
  <Future>_Manual/
    index.md
    manual.json
    img/

Building a PDF​

cd docs/composite/
npm install          # first time only
node build_pdf.mjs Raptor-C_FALCON_Manual

Output: build/Raptor-C_FALCON_Manual.pdf

What goes into a composite manual​

  1. Hardware -- pinout, connectors, mechanical drawings, environmental specs
  2. Firmware -- parameter tree, signal conditioning, presets, state machine
  3. Software -- connecting via CAN/USB, YOS shell commands, firmware update
  4. Quick Start -- abbreviated setup using accessories (e.g. Quick-setup pad)
  5. Troubleshooting -- common issues and LED diagnostics

Conventions​

  • ASCII-only in Markdown source (build tools may corrupt UTF-8)
  • Use mermaid fenced code blocks for flow diagrams (rendered at build time)
  • Images go in img/ with descriptive filenames
  • Keep generated PDFs out of version control (add to .gitignore)
  • Document version and generation date appear on the cover page automatically