docs: add current developer feature index

This commit is contained in:
Rijad Zuzo
2026-08-13 00:26:55 +02:00
parent 149e043f86
commit 9872b986b6
21 changed files with 1296 additions and 45 deletions
+23 -8
View File
@@ -1,35 +1,50 @@
# Documentation map
Start with [`DEVELOPER_INDEX.md`](DEVELOPER_INDEX.md). It is the developer
onboarding index: a current feature matrix, repository map, extension workflow,
verification commands, and links into the detailed contracts below.
The project uses a small hierarchy so overlapping plans do not become competing
sources of truth.
This directory is intentionally covered by `.gdignore`: plans and baseline
captures are review artifacts, not runtime Godot resources.
1. [`PROJECT_CONTEXT.md`](PROJECT_CONTEXT.md) is the canonical description of
1. [`DEVELOPER_INDEX.md`](DEVELOPER_INDEX.md) is the current implementation
index and the fastest route to a feature slice.
2. [`PROJECT_CONTEXT.md`](PROJECT_CONTEXT.md) is the canonical description of
the vision, current implementation, target architecture, and active
constraints.
2. [`ARCHITECTURE_OVERVIEW.md`](ARCHITECTURE_OVERVIEW.md) is the concise map of
3. [`ARCHITECTURE_OVERVIEW.md`](ARCHITECTURE_OVERVIEW.md) is the concise map of
runtime ownership, folder responsibilities, and dependency rules.
3. [`LEARNING_ROADMAP.md`](LEARNING_ROADMAP.md) owns milestone order,
4. [`LEARNING_ROADMAP.md`](LEARNING_ROADMAP.md) owns milestone order,
architecture gates, reusable-system exit tests, and intentionally deferred
work.
4. [`BUILD_IN_PUBLIC_PLAN.md`](BUILD_IN_PUBLIC_PLAN.md) owns the scoped Jajce
5. [`BUILD_IN_PUBLIC_PLAN.md`](BUILD_IN_PUBLIC_PLAN.md) owns the scoped Jajce
visual slice. It must respect the architecture gates in the learning
roadmap.
5. [`RESOURCE_NODE_MIGRATION.md`](RESOURCE_NODE_MIGRATION.md) is a focused
6. [`RESOURCE_NODE_MIGRATION.md`](RESOURCE_NODE_MIGRATION.md) is a focused
migration plan. Phases 16 are complete; follow-up work should expand
resource discovery without reintroducing abstract resource zones.
6. [`ACTION_SYSTEM_ARCHITECTURE.md`](ACTION_SYSTEM_ARCHITECTURE.md),
7. [`ACTION_SYSTEM_ARCHITECTURE.md`](ACTION_SYSTEM_ARCHITECTURE.md),
[`ECONOMIC_EVENTS.md`](ECONOMIC_EVENTS.md),
[`FOOD_STORAGE_ARCHITECTURE.md`](FOOD_STORAGE_ARCHITECTURE.md),
[`REGIONAL_SIMULATION.md`](REGIONAL_SIMULATION.md),
[`SIMULATION_DEFINITIONS.md`](SIMULATION_DEFINITIONS.md), and
[`SIMULATION_STATE_SCHEMA.md`](SIMULATION_STATE_SCHEMA.md) document the
current data contracts.
7. [`decisions/`](decisions/) contains durable architectural decisions,
8. The implementation guides explain the larger slices without replacing the
narrow contracts: [authored content](FEATURE_CONTENT_AND_AUTHORED_DATA.md),
[commands and economy](FEATURE_COMMANDS_TARGETS_AND_ECONOMY.md),
[events through dialogue](FEATURE_EVENTS_KNOWLEDGE_SITUATIONS_DIALOGUE.md),
[regional simulation](FEATURE_REGIONAL_SIMULATION_AND_PERSISTENCE.md),
[entity families](FEATURE_ENTITIES_COMBAT_ANIMALS.md),
[presentation/performance](FEATURE_PRESENTATION_PERFORMANCE.md),
[saves/migrations](FEATURE_SAVE_SCHEMA_AND_MIGRATIONS.md), and
[testing/benchmarks](FEATURE_TESTING_AND_BENCHMARKS.md).
9. [`decisions/`](decisions/) contains durable architectural decisions,
including consequences and revisit conditions.
8. [`benchmarks/`](benchmarks/) contains reviewed, workload-specific
10. [`benchmarks/`](benchmarks/) contains reviewed, workload-specific
performance ledgers and their machine-readable samples. Measurements are
local evidence, not portable CI limits.