Repository navigation
Remove remaining consumer-mod references from API documentation #317
Description
Why
The API knows the game, never other mods: VGModAPI provides an API, not the mods built with it
(#313 cleanup removed all consumer awareness from code, harness and examples — TractorCase and
name-specific staging became API-owned cases plus a generic --stage). A repo-wide grep now shows
the residue is confined to five documentation files that still name specific consumer mods. Docs
should speak in capabilities and game vocabulary; consumer-specific history belongs in PRs and
issues, not reference documentation.
Findings (from git grep on main @ bb246ae)
| File | Issue | Suggested rewording |
|---|---|---|
docs/reference/mission-events.md:5 |
"…belongs to MissionJournal … without a MissionJournal dependency." | Describe the capability boundary: descriptive journal history is a consumer concern the API does not own. |
docs/reference/navigation.md:19 |
"Stockpile-style station locators and ItemCompass-style distance lists" | Name the UI capability, not the mods: "station-locator and distance-list UIs can use these operations". |
docs/reference/persistence-identity.md:38 |
"External CustomMission progression and archived TravelJournal are not migration targets." | "Data owned by external mods (including archived ones) is never a migration target." |
docs/reference/persistence-safety.md:48,50 |
Silos-specific recovery row and scoping sentence | Generalize to "runtime-registered custom items inserted into native catalogs by a consumer mod". |
docs/reference/travel-events.md:71 |
"TravelJournal remains archived and is not an integration target." | "Archived external journal mods are not integration targets." |
Borderline, decide when fixing: examples/StationCommerce product text "not an installable silo"
(README + OwnedItemDefinition description). Note the description feeds the item's NativeId
hash, so changing the string is a persisted-identity change for saves that already contain the
example good; it is dev-only, so acceptable — but call it out in the fixing PR.
Out of scope here
- Game vocabulary stays as-is:
TractorModule,TractorBeamRuntime,ConfigurePlayerTractorModules
etc. mirror game types (naming rule established in feat: expose equipment targeting, skill trees and tooltip extensions #313). - Mod-to-mod mentions inside sibling repositories (e.g. CustomMission docs) belong to those repos.
- Stale local API worktrees (
api-clean-surface,api-design,api-domain-reactions,
consumer-patch-removal,settings-save-example, merged others) carry old doc copies; prune
them once their PRs are merged so they stop surfacing in greps.
Definition of done
git grep -i -E 'TractorAuto|LootTint|ItemCompass|MissionJournal|TravelJournal|VGAnima|VGSilos|VGEcho|Stockpile|CustomMission' -- docs returns only
intentional, non-doc hits (ideally nothing), and the five files above read as capability
documentation. Pure documentation change; no code or API surface changes.
Activity