docs: reorganize reference/, add library reference docs, remove POC - #24
Merged
Merged
Conversation
Restructure docs/reference/ into categories, fill the per-library reference-doc gap, remove the frozen POC docs, and clear accumulated staleness. Docs only (the two enginseer/discovery changes are comment-only). Reference re-org (docs/reference/ now categorized): - darktide/ — darktide-binary.md (game-binary facts) - community-tools/ — darktide-framework-analysis.md + analysis-verification.md - magos-modificus/ — NEW per-library API reference (7 docs: general, config, profiles, shared-mods, steam, integrations, enginseer-client), authored from the code: public interfaces/methods, key types, DI registration, cross-platform notes. Index README rewritten for the categories. Architecture: - MAGOS-MODIFICUS.md: new "Composition & startup" section (composition root, Add<Library>() chain + ordering, startup sequence, TryAdd DI contract); status block + project layout updated to Phases 0-2; the broken DMF-sourcing claims rewritten as the open Phase-4 decision. POC removal: - Delete docs/poc/ (9 files) — the load-bearing content was already distilled into docs/reference/darktide/ + docs/architecture/. - Clean all docs/poc link leakage across AGENTS.md, the architecture docs, docs/reference/, the root README, and two enginseer/discovery Rust comments that cited the deleted production-spec. (The poc *branch* refs in AGENTS.md are intentionally kept — only the docs *folder* is removed.) Doc currency: - Fix stale status everywhere (Phase 0 scaffold -> Phases 0-2; integrations/ steam/enginseer-client stub labels -> implemented) across AGENTS.md, root README, magos-modificus/README, architecture/README + MAGOS-MODIFICUS. - AGENTS.md: complete the tests list (Integrations/Steam/EnginseerClient); add the per-library reference-doc maintenance rule to the doc-currency section.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Housekeeping across
docs/+AGENTS.md. Docs only (the twoenginseer/discoverychanges are comment-only).What changed
Reference re-org —
docs/reference/is now categorized:darktide/—darktide-binary.md(game-binary facts)community-tools/—darktide-framework-analysis.md+analysis-verification.mdmagos-modificus/— NEW per-library API reference (7 docs:general,config,profiles,shared-mods,steam,integrations,enginseer-client), authored from the code (public interfaces/methods, key types, DI registration, cross-platform notes). Index README rewritten.Architecture —
MAGOS-MODIFICUS.md: new Composition & startup section (composition root,Add<Library>()chain + ordering, startup sequence,TryAddDI contract); status + project-layout updated to Phases 0–2; the broken DMF-sourcing claims rewritten as the open Phase-4 decision.POC removal — deleted
docs/poc/(9 files). The load-bearing content was already distilled intodocs/reference/darktide/+docs/architecture/(verified: every POC "unproven/risk/must-verify" item is either resolved by the built runtime or tracked as future work). Cleaned alldocs/poclink leakage acrossAGENTS.md, the architecture docs,docs/reference/, the root README, and twoenginseer/discoveryRust comments that cited the deletedproduction-spec. Thepocbranch refs inAGENTS.mdare intentionally kept — only the docs folder is removed.Doc currency — stale status fixed everywhere (Phase 0 → Phases 0–2; integrations/steam/enginseer-client "stub" → implemented) across
AGENTS.md, rootREADME,magos-modificus/README,architecture/README+MAGOS-MODIFICUS.AGENTS.mdtests list completed; per-library reference-doc maintenance rule added to the doc-currency section.Validation
MagosComposition.csexactly; re-org consistency confirmed (no residualdocs/pocor old reference paths; all anchors resolve). Two findings folded in (root README status miss; two dangling Rust comment citations).docs/pocreferences in code or docs.Decisions made (redirect if wrong)
MAGOS-MODIFICUS.md(not a separate doc).analysis-verification.mdplaced incommunity-tools/(it also auditsdarktide-binary, minor).Not in this PR (flagged for follow-up)
config.example.jsonvalues are literal<app-data>/...placeholders (a footgun — an empty file is safer than the example verbatim); a staleProgram.cspath in the enginseer-client.Tests csproj comment; an unusedDarktideSteamAppIdconst; Steam is the one backend library that doesn't referenceMagosConfig(intentional, asymmetry only).