Files
LlamaCasty/docs/ai/index.md
T
gramps c9ac348976 docs(ai): ai.md becomes a router; invariants move to AGENTS.md; budgets gated
ai.md 228 → 64 lines. It now carries only: what the product is, the build
commands, the architecture table, a "where the truth lives" table, and a
pointer to HANDOFF. No narrative, no status, no duplicated invariants.

AGENTS.md (195 lines) is now the single always-read file:
- the 20 invariants that break output, wipe user data, or ship a legal/trust
  breach — one line each, pointing at the doc that explains it (they replace
  110 lines of invariant stubs that duplicated docs/ai/*.md verbatim)
- Response style + No-Fluff Mode moved in from ai.md (rules belong in the rules file)
- onboarding is now: HANDOFF → ai.md router → the ONE docs/ai file → dir index;
  TASKS.md is read when the question is "what's next", not to write code
- memory rides with the change but is no longer a unit of its own; HANDOFF is
  ≤40 lines and overwritten, never appended

Anti-rebloat gate: scripts/verify.sh gains step 1/4, a doc-budget check
(AGENTS ≤210, ai ≤100; HANDOFF/TASKS caps land with the queue trim). A commit
that pads a capped file instead of moving detail fails the gate.

schema.md and docs/index.md corrected for the new roles and reading order.
Docs-only unit: scope-check run, no build.
2026-10-29 11:08:07 -07:00

3.1 KiB

docs/ai — index

Subsystems split out of ai.md so a session pays only for the subsystem its task touches. ai.md is now a router (what the product is, the architecture table, where truth lives) and AGENTS.md carries the invariants that hold across all of them, so no rule is reachable only from a file you forgot to open.

Read the file whose row matches the task. There is no required reading order.

File Covers Read when
frame-pipeline.md Render budget & measurement (FrameCadence, per-element composite timing, scene dump), SceneCompositor design + StripPool, and FramePump from scene snapshot to encoder (pacing, pool/paste caches, backpressure, teardown, health stats) Touching the compositor, the render loop, per-frame cost, Services/Encoder/*, or debugging dropped/juddering frames
capture.md The locked Background layer (screen/game/window capture, WinRT GraphicsCapture interop), the webcam seam + CameraManager sessions, MediaPipe background effects, and the vertical 9:16 tier's per-scene camera placement Touching any frame source, the Background row, camera acquisition/conflicts, background effects, or vertical-tier camera geometry
output.md The bundled ffmpeg.exe and the encoder subprocess (args, probe order, seams), local recording (REC/ON-AIR, filenames, private-broadcast close-out), and the WASAPI capture → filter → mix → named-pipe audio chain (TRAX, sync offset, ducking, limiter) Touching ffmpeg args/bundling, encoder or recording behaviour, REC/ON-AIR, the audio mix and its meters, or loudness/sync problems
environment.md LAN hosts/IPs/SSH and the Gitea push recipe, the Windows dotnet.exe build + run commands, the test suite map, and the hermetic real-MainWindow test rule Before building, running, adding a test, or reaching any box on the LAN
product.md Brand/naming split, AI transparency, the GPL licensing prohibitions, the free-forever monetization posture, auth/account assumptions, and packaging/distribution Branding, marketing, pricing, licensing, or packaging decisions
youtube-api.md Go-live ordering + the broadcast-binding fix, the private-only lock, health parsing, end-stream pre-flight, Test mode, and chat-insert shape Touching go-live, broadcast lifecycle, health polling, streaming close-out, or the chat service
overlays.md The social bar, the native alert box (six animations, alert clip, ticker) and the chat box conventions — everything composited over the frame Adding or changing anything drawn on top of the output
ui-surface.md The control surface, scene strip, preview rail, hotkeys, broadcast drawer, toasts, transitions, brand logo, launch geometry, and the theme/properties-panel conventions Changing anything the creator sees: layout, controls, theming, properties panel

Split-out yet to come

Nothing — ai.md is now a router with the always-read invariants; the subsystem detail lives here.