Documentation coverage
This page maps audiences, topics, and where they live in MkDocs. Content is curated for CSRetro (paths, binaries, defaults). Internal rules for authors are in Contributing and .github/documentation-policy.md (repository only).
Audiences
| Audience |
Primary pages |
| Players |
Players, Client component, Client CVARs |
| Server administrators |
Server administrators, Server CVARs, Metamod, NodeMod, YaPB, NodeMod – CSRetro |
| Developers |
Developers, Building, Architecture, Repository artifacts, Vendor table (VENDOR.md) |
Gap matrix (topics × documentation status)
Rows are topics CSRetro operators and developers need. Columns point to the page(s) that carry the mandatory facts (self-contained handbook).
| Topic |
Players |
Server hosts |
Developers / builders |
Primary doc pages |
| Install, launch, assets |
✓ |
✓ (dedicated) |
✓ |
Players, Building, Server administrators |
| Client CVARs, binds, HUD/crosshair |
✓ |
— |
✓ |
Players, Client CVARs, Client |
Server CVARs (mp_*, sv_*, bot_*) |
— |
✓ |
✓ |
Server CVARs, Server administrators |
Metamod (meta, plugins.ini, paths) |
— |
✓ |
✓ |
Metamod, Server administrators |
| NodeMod (plugins, admin, npm pipeline) |
✓ (menus) |
✓ |
✓ |
NodeMod, nodemod-csretro.md |
YaPB (yb_*, graphs, conflicts with ReGame bots) |
— |
✓ |
✓ |
YaPB |
| Engine env vars, in-tree engine docs |
— |
✓ (networking) |
✓ |
Engine |
Versions / VENDOR.md (csr version, MOTD) |
✓ (MOTD) |
✓ |
✓ |
Vendor table (VENDOR.md), Server administrators |
| Cross-cutting summaries |
— |
✓ |
✓ |
Cross-component reference, Reference hub |
Legend: ✓ = audience typically needs this topic.
Policy
| Topic |
Page |
Single handbook surface, VENDOR.md, no mirrors in Git |
Contributing, .github/documentation-policy.md |
Topics by source (integrated into our docs)
| Topic |
Where documented in CSRetro |
NodeMod plugin layout, admin pipeline, plugins.ini |
nodemod-csretro.md, components/nodemod.md, Cross-component reference |
YaPB CVars (yb_*), quota modes, config paths |
components/yapb.md, Server administrators, Server CVARs |
Metamod-R meta commands, clientmeta, plugins.ini lines |
components/metamod.md, Server administrators |
Xash3D engine env vars, Documentation/ topics |
components/engine.md, Developers |
| cs16-client launch args, client CVars |
components/client.md, Players, Client CVARs |
Toolchain, requirements-docs.txt, MkDocs |
Building, Developers |
Component revisions, csr version |
Vendor table (VENDOR.md), [VENDOR.md](https://github.com/benjarogit/csretro/blob/main/VENDOR.md) (repo root) |