RenderBrains Docs

Official knowledge base for the RenderBrains rendering engine and toolset.

Welcome to the RenderBrains documentation.

RenderBrains is a real-time rendering engine and toolset for high-performance graphics. This site serves as the team’s shared knowledge base, covering architecture decisions, development guides, and technical references.

Knowledge Types

Section structure follows the Diátaxis knowledge framework.

Tutorials

Step-by-step learning guides for newcomers. Walk through core concepts and workflows in sequence.

How-To

Practical recipes for completing specific tasks. Look here when you know what you want to achieve.

Reference

Technical reference for APIs, configuration schemas, and enumerated values to consult while working.

Explanation

Internal architecture, design principles, and Architecture Decision Records (ADRs).

LLM Wiki Pattern

The structure and operation of this knowledge base is based on Andrej Karpathy’s LLM Wiki Pattern.

3 Layers

Layer	Location	Owner
Raw Sources	`vault/` (local only, gitignore)	Human
The Wiki	`wiki/` (git-tracked)	LLM
The Schema	`CLAUDE.md`, `ARCHITECT.md`	Shared

Raw Sources are immutable — the LLM reads them but never modifies them. The Wiki is the LLM-owned synthesis layer, tracked in git, growing richer as sources accumulate.

3 Operations

Ingest — Integrate new sources into the wiki. Update relevant pages, refresh wiki/index.md, and append a record to wiki/log.md.

Query — Synthesize answers from accumulated wiki knowledge. Valuable answers are saved as new wiki pages, allowing the knowledge base to keep growing.

Lint — Audit wiki health. Detect and report contradictions, orphaned pages, broken links, and stale content.

Installation

1. Install Quarto

Download the installer for your OS from quarto.org/docs/get-started. Requires v1.4 or later.

quarto --version  # verify installation

2. Install uv (Python package manager)

# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

3. Clone the repository and install dependencies

git clone https://github.com/sungkukpark/renderbrains-docs.git
cd renderbrains-docs
uv sync

4. Run the full pipeline

make run   # runs sync → lint → build in sequence

All three stages must pass before committing to main.

Individual commands

make sync      # wiki/ → site content conversion
make lint      # frontmatter and link validation
make build     # quarto render → _site/
make preview   # local preview (live reload)
make clean     # delete _site/ and __pycache__

Contributing

Documentation is authored in Obsidian (vault/) and published via Quarto. See the README for the full workflow.