SDBS

General Purpose SSCCS Technical Documentation Build System

• A high-level orchestration layer for docs generation solutions (currently Quarto-driven).

Quick Start

With pip

pip install sdb
sdb init docs
sdb build docs --website

With Docker

docker pull ghcr.io/ssccsorg/sdbs:latest
docker run --rm -v $(pwd)/docs:/work -w /work ghcr.io/ssccsorg/sdbs:latest sdb build docs --website

Try the example project

git clone https://github.com/ssccsorg/sdbs.git
cd sdbs
./examples/build.sh quickstart

This installs SDBS from source (or uses Docker if Quarto is not available) and builds the examples/quickstart/ project — a minimal documentation site with a landing page, a getting-started guide, and an API reference.

CLI Reference

# Scaffold a new docs directory
sdb init docs
sdb init docs --template ssccs     # with SSCCS-specific templates

# Build all targets
sdb build .
sdb build . --website -j 4         # parallel website build

# Pre-render steps (latest docs, path resolution, footnote cleanup, formatting)
sdb pre docs

# Validate links and citations
sdb check .

# Render a single document by short name for quick preview
sdb render map
sdb render map --to pdf            # render to a specific format

# Render and collect PDF artifacts (PDF, LaTeX, figures, media)
sdb pub map
sdb pub map --all                  # render all matches without prompting

# Remove Quarto build artifacts (_cached/, _files/, html, pdf...)
sdb clean docs

Pre-build Sequence

pre and every build invoke the same built-in pre-build sequence before rendering. The sequence runs in four phases.

• Latest docs: regenerate _include/_updated_docs_list.qmd from git-tracked documents.
• Path resolution: resolve relative asset paths and includes across QMD and MD files.
• Footnote deduplication: in each .qmd, remove every use of a footnote tag after the first. Footnote definitions, YAML front matter, fenced code blocks, inline code spans, and escaped references are preserved.
• Formatting: run rumdl fmt with MD036 disabled.

The sequence is idempotent. Running sdb pre docs on an already-clean tree changes nothing. Documents rendered through sdb render or sdb pub skip this sequence, since those commands call the underlying renderer directly without preprocessing.

Documentation

• SDBS: the project index, covering the build architecture, the parallel build model, and the LLMs pipeline.
• Single-Path Artifact Pipeline: one container image carrying emulation, RTL verification, and documentation, with the agent knowledge base extracted from the same build.
• The Living Corpus: SDBS as the knowledge-ization engine, from document corpus to living knowledge.

Development

Setup

git clone https://github.com/ssccsorg/sdbs.git
cd sdbs
pip install -e .

Run tests

python -m pytest tests/ -v

Build the Docker image

docker build -t ghcr.io/ssccsorg/sdbs:latest .

License

Apache 2.0