Site Guide
This site records engine internals as principle → source path → engineering impact, rather than restating official API usage. Content is organised by directory: adding a document requires no configuration change.
Writing principles
- Principle first: conclusions follow from source paths, and state the thread boundary, lifetime and engineering impact instead of listing API calls.
- Zero-config growth: a category is a folder; its order comes from
_category_.json, and the left navigation tree for technical docs is generated from the directory structure. Site-level sections stay out of that tree; see "Site information" below. - Kept current: every document's frontmatter states the code revision it targets, and content changes feed the changelog delivered to subscribers.
Directory layout
docs/ue/memory/ memory management
docs/ue/rendering/ rendering pipeline
docs/ue/networking/ network synchronisation
On freshness: the source moves, docs lag behind. The
updatedand version fields in each document's frontmatter state the code revision it targets. When a conclusion disagrees with the current release, trust the source — and corrections are welcome.
Adding a document
Run this from the project root (or double-click new-doc.bat):
npm run new -- docs/ue/memory/my-new-doc.md
The generated template carries a complete frontmatter. Write the body and save; the dev server refreshes automatically. Before merging, CI validates frontmatter, compiles MDX and checks for broken links.
Where to start
- Thread boundaries of FStreamableManager async callbacks: enter object lifetimes through the async load callback.
- Parallel splitting of FrustumCull and ComputeRelevance: how frustum culling and relevance computation are split across tasks.
Site information
These sections describe the site itself rather than engine internals, so they stay out of the technical sidebar:
- Changelog: yearly document changes; entry rules live in the "Entry specification" page of the same folder.
- Writing conventions: content pack structure and available rendering features.
- Publishing and maintenance: build, deploy and content update handbook.