Skip to content
THE DEVELOPMENT WIKIPROJECT I SPACE FANTASY · CO-OP FPS · ROGUELIKE

Keeping the wiki current

Edit system pages directly and edit catalog-notes.json for individual entry explanations/aliases. Entity pages under _generated/ are rebuilt from static repository input; do not hand-edit them.

After a mechanics change

  1. Review the actual source/authoring diff and update the relevant explanations, exclusions and status.
  2. Run Tools/Wiki/Refresh-Wiki.ps1 to regenerate catalogue pages, manifest and source provenance.
  3. Run Tools/Wiki/Test-Wiki.ps1, then Tools/Wiki/Build-Wiki.ps1.
  4. Preview long/changed pages and test search by current name and alias.
  5. Link appropriate gameplay evidence without treating docs checks as gameplay validation.

The collector rejects unsupported catalogue grammar, duplicate IDs/GUIDs, missing required refs, invalid roster count and source changes during collection. Extend the parser with a focused failing fixture before supporting a new source shape. Do not replace static collection with a Unity invocation in this documentation-only workflow.

Paths and generated output

Path Purpose
Docs/Wiki/ Authored pages and generated checked catalogue
Docs/Wiki/catalog-notes.json Editable entry summaries, interactions and aliases
Docs/Wiki/_generated/catalog.json Deterministic inventory and input hashes
Docs/Wiki/_generated/provenance.json Generation time/revision/dirty-state record
Docs/Wiki/content-manifest.json Type-qualified identity/page coverage
Docs/Wiki/_sources/ Ignored local copies of explicitly linked source/evidence text
Docs/wiki.mkdocs.yml Theme, search and build configuration
Tools/Wiki/ Documentation-only collector, tests and wrappers
Builds/Wiki/ Ignored generated static website

The local preview binds to loopback. The user authorized public hosting, including the wiki's linked source copies, on 16 October 2026. Cloudflare Pages project projecti-wiki uses projecti-wiki.pages.dev for public static Direct Uploads, without Access restrictions, Functions or a paid upgrade. The hosted website stays available while the development PC is off. Publication is separate from local preview, catalogue refresh and build.

Update the hosted wiki

Review content/source changes, run refresh, tests and build above, then upload only Builds/Wiki to the existing Pages project's production environment. Preserve index.html at the upload root. Local commits/previews do not automatically update the hosted site.

Use the Cloudflare dashboard's Workers & Pages > projecti-wiki > Create deployment Direct Upload flow, or the pinned CLI command in Tools/Wiki/README.md. The dashboard accepts the built folder or a ZIP of its contents. Linked _sources/ copies are intentionally public documentation; exclude credentials, .git, caches, deployment tooling and game build outputs from the upload.

Dependency and rendering choices

MkDocs 1.6.1 and Material 9.7.7 are pinned with their installed dependency versions in Tools/Wiki/requirements.txt. MkDocs uses BSD licensing and Material uses MIT licensing; consult package licence files before redistribution. Fonts are system-local, and the wiki needs no remote font/analytics service.

Official documentation: MkDocs, Material search.

Core/ability SVGs are source-derived documentation illustrations of the project's original procedural icon vocabulary. A restricted numeric geometry parser and static SVG translation run outside Unity; no C# is executed. Source-helper fingerprints require review if that artwork changes. They do not reproduce Unity materials, lighting or runtime screenshots. The space masthead is an original documentation SVG; no third-party game art was copied from the supplied layout reference.

Evidence style

Write Current/Planned/Legacy separately from source, automated, Editor, network and human acceptance. State assumptions beside derived calculations. Preserve metre/second/round/pellet/trigger units. Use type-qualified names for collisions such as Bulwark passive versus planned enemy.

Diagrams and schematic motion

AI diagrams under assets/ai/ are original local SVG documentation drawings, not gameplay captures. Solid cyan denotes implemented flow/observed facts; amber denotes hypotheses or limits, green checked results, grey geometry and dashed violet planned coordination. Shapes and labels repeat colour meanings. Captions state status, units and whether values are illustrative. Narrow pages scroll each diagram locally to keep labels readable.

Regenerate the paired search illustrations with Tools/Wiki/.venv/Scripts/python.exe Tools/Wiki/generate_search_diagrams.py from the repository root. The pair separates wall-hit predictions from movement extrapolation and independent radial sampling. Its assertions check wall hits/miss, visible last sight, wall-free observed motion and example arithmetic; they are documentation checks, not native navigation or gameplay proof.

assets/ai-explainers.js progressively enhances static explanations with user-started, finite schematic sequences. Keep pause/resume, replay, hidden-tab pause and reduced-motion fallback. No JavaScript still leaves the sequence and timing text usable. It uses no new dependency or remote asset. Check controls, end/replay, reduced motion, keyboard focus and narrow layouts after changes; this animation is never simulation or gameplay evidence.