Reorganize docs into category folders and drop the retired head-review page
Full build / Import + headless tests (push) Successful in 41s
Full build / Full desktop build + optional release (push) Skipped

Group the top-level docs into docs/project, docs/design, docs/assets and
docs/process, each with its own README index. Delete the superseded
docs/screens/head-review page and sheets. Rewrite every markdown link,
absolute docs path and tool/test reference to the new locations, fix the
pre-existing broken anchors and remove the dead Joke Shop photo-board link.
check_docs OK, Python tooling 167/167.
This commit is contained in:
zwitschi committed 2026-11-06 20:13:03 +01:00
1 parent 045ed2a58f
commit 2ba40f3578
57 files changed
+406 -414

No files matched your search

+31 -30
View File
@@ -1,42 +1,43 @@
# Gig Line Documentation
This folder holds the project documentation, visual references and generated QA evidence.
Documentation is grouped by category. Product intent, the gap analysis and the release roadmap
live in [`../PLAN.md`](../PLAN.md); the executable task list is [`../TODO.md`](../TODO.md); the
workflow rules are in [`../AGENTS.md`](../AGENTS.md).
## Current priorities
## Categories
1. [Quaternius NPC base migration](../TODO.md#quaternius-npc-base-migration-top-priority) — CC0 Quaternius mesh/animation source baked to the 24,000-budget runtime contract.
2. [3D model and local map improvements](../TODO.md#3d-model-and-local-map-re-evaluation) — asset re-evaluation and local map reconstruction.
3. [0.10.0 release candidate](../TODO.md#milestone-0100--3d-model-and-map-improvements-minor) — versioned release hardening after the unversioned development tracks.
| Folder | Contents |
| --- | --- |
| [`project/`](project/README.md) | Architecture (arc42) and the implemented-features status |
| [`design/`](design/README.md) | Gameplay, venues, UI copy, accessibility and known limitations |
| [`assets/`](assets/README.md) | Blender library, asset tooling, NPC sourcing and the 3D model review |
| [`process/`](process/README.md) | Setup/controls, release QA and the release runbook |
| [`adr/`](adr/README.md) | Architecture Decision Records |
| [`screens/`](screens/README.md) | Licensed references, concepts and screen designs |
| [`blender_previews/`](blender_previews/README.md) | Committed character/gear/prop preview sheets |
| [`screenshots/`](screenshots/README.md) | The committed in-game gallery |
## Start here
- [`../PLAN.md`](../PLAN.md) — product, design intent and development priorities
- [`../TODO.md`](../TODO.md) — priority-ordered active tasks and roadmap
- [`npc-model-sourcing.md`](npc-model-sourcing.md) — character-source evaluation, licence rules and the character-development plan
- [`makehuman-head-review.md`](makehuman-head-review.md) — retained MakeHuman fallback head, provenance and review verdict
- [`architecture.md`](architecture.md) — arc42 system architecture
- [`getting-started.md`](getting-started.md) — setup, run/test commands and controls
- [`asset-tooling.md`](asset-tooling.md) — image/model pipelines and screenshot gates
- [`../tools/README.md`](../tools/README.md) — tool inventory, categories and test runner
- [`gameplay.md`](gameplay.md) — controls, venues and escalation
- [`venues.md`](venues.md) — Hollywood, Joke Shop and TV Studio real-site mapping
- [`3d-model-review.md`](3d-model-review.md) — 3D model re-evaluation: measurements, scorecard and ranked gaps
- [`development-status.md`](development-status.md) — implemented features, current gaps and active planning
- [`accessibility.md`](accessibility.md) — accessibility statement and known gaps
- [`known-limitations.md`](known-limitations.md) — release-candidate blockers and accepted limits
- [`release-qa.md`](release-qa.md) — manual smoke checklist and balance-acceptance protocol
- [`../CREDITS.md`](../CREDITS.md) — credits and asset provenance
- [`../PRIVACY.md`](../PRIVACY.md) — privacy note
- [`ui-copy.md`](ui-copy.md) — screen, copy and button inventory
- [`RELEASING.md`](RELEASING.md) — export, CI and publishing workflow
- [`adr/README.md`](adr/README.md) — architecture decisions
- [`../PLAN.md`](../PLAN.md) — product, design pillars, gap analysis and the roadmap to 1.0.0
- [`../TODO.md`](../TODO.md) — milestone-ordered active tasks
- [`project/architecture.md`](project/architecture.md) — system architecture and ownership
- [`project/development-status.md`](project/development-status.md) — what the build supports now
- [`design/gameplay.md`](design/gameplay.md) — the playable loop and escalation model
- [`design/venues.md`](design/venues.md) — venue mapping and real-site evidence
- [`assets/npc-model-sourcing.md`](assets/npc-model-sourcing.md) — the active NPC base and licence
rules
- [`assets/3d-model-review.md`](assets/3d-model-review.md) — asset measurements and scorecard
- [`process/getting-started.md`](process/getting-started.md) — setup, run/test and controls
- [`../tools/README.md`](../tools/README.md) — tool inventory and test runner
- [`../CREDITS.md`](../CREDITS.md) — credits, AI/reference provenance and licensing
- [`../PRIVACY.md`](../PRIVACY.md) — local-only data and save files
## Visual references
## Current work
- [`screens/README.md`](screens/README.md) — concepts, designs, screenshots and realism runs
- [`blender_previews/README.md`](blender_previews/README.md) — character/gear/prop previews
- [`screenshots/README.md`](screenshots/README.md) — committed game gallery
- [`ui-copy.md`](ui-copy.md#screen-design-judge-report) — screen/button inventory and latest judge result
v0.9.9 shipped the Quaternius NPC roster. The active patch line is `0.9.10` (roster follow-ups:
outfit families, the Swat base orientation, per-slot atlases) through `0.9.12`, followed by the
`0.10.0` public-readiness minor. See [`../TODO.md`](../TODO.md) for the live checklist.
## Quick preview