Skip to content

DOC-RECONCILIATION.md

Latest commit

 

History

History
88 lines (61 loc) · 4.39 KB

DOC-RECONCILIATION.md

File metadata and controls

88 lines (61 loc) · 4.39 KB
Raw

DOC-RECONCILIATION

This file was generated by the /doc-truth-up documentation-reconciliation pass. It treats the code as read-only ground truth and edits only documentation so it reflects the repo's actual current state. No source code was modified, and no builds or tests were run.

Per-claim findings

1. What it is

Status: consistent Evidence: src/main.rs:9 — window title "Desktop Terrarium"; src/main.rs:10 — 800×600 resolution; src/main.rs:12 — resizable: true; Bevy engine confirmed via Cargo.toml:7. README description matches exactly.

2. Current state (implemented features)

Status: consistent Evidence: All six advertised features verified in code:

  • Activity-driven growth: src/components/plant.rs:18-21 (Fern/Moss/Succulent), src/systems/plant_growth.rs (growth stages 0–4)
  • Idle detection: src/systems/behavior_tracker.rs:8-9 (CGEventSourceSecondsSinceLastEventType via CoreGraphics)
  • Dynamic weather: src/resources/weather.rs:19-24 (Clear/Fog/Rain/Wind), phase_duration_secs: 300.0 (5 min), transition_duration_secs: 30.0 (30 sec)
  • Critter visits: src/systems/critter_spawner.rs:19 (butterfly at >= 1800.0 secs = 30 min focus), beetle with 5% chance/minute
  • Time-of-day: src/resources/time_of_day.rs:26-32 (morning/day/evening/night phases with crossfade)
  • Persistence: src/systems/persistence.rs:42-43 (Timer::from_seconds(300.0, ...) = every 5 minutes)

Tests exist: src/systems/persistence.rs:214-318 (3 tests), src/systems/behavior_tracker.rs:76-128 (3 tests).

3. Stack

Status: consistent Evidence: Cargo.toml:3 (edition = "2021"), Cargo.toml:7 (bevy = { version = "0.15" }), Cargo.toml:8-9 (serde, serde_json), Cargo.toml:13 (dirs = "6"), src/systems/behavior_tracker.rs:9 (CoreGraphics idle detection).

4. How to run

Status: consistent Evidence: Cargo.toml is present; cargo run and cargo build --release are the only documented commands and both are valid for a Cargo binary crate. Scripts scripts/check_local_artifacts.sh and scripts/clean.sh both exist on disk.

5. Known risks (code↔doc contradictions)

Status: drifted — two items fixed (see below)

5a. False Bevy feature flags — FIXED

File: docs/FIRST-BOOT-AND-NESTED-LAYOUT.md (Section 5) Before: Claimed two custom features exist:

  • stable-core — core terrarium gameplay (always on)
  • experimental-weather — weather plugin (on by default; toggle with --no-default-features --features stable-core)

After: Replaced with accurate description: Cargo.toml has no [features] section. The only non-default Bevy option is features = ["wayland"] (enables Wayland backend on Linux; no-op on macOS). Evidence: Cargo.toml — grep for [features], stable-core, experimental-weather returns nothing.

5b. Stale "last commit on master" reference — FIXED

File: docs/FIRST-BOOT-AND-NESTED-LAYOUT.md (Section 8) Before: b2fc2ca chore(ci): guard local artifacts and trim placeholders After: 4def9cb docs: nested-repo layout and first-boot validation walkthrough (#2) Evidence: git log --oneline -1 → 4def9cba4675dca65e09c451a580b256d5da8f54

6. Next move (demonstrably incomplete)

Status: unverifiable Reason: The CHANGELOG has only "Initial release" under [Unreleased]. No roadmap file exists in the repo. The docs/FIRST-BOOT-AND-NESTED-LAYOUT.md mentions codex/release-audit-hardening as a hardened-CI branch — its existence and state cannot be verified from the working tree alone.

Cross-doc inconsistency for manual review

Location Issue Suggested fix
README.md:27-28 Installation shows cd DesktopTerrarium (GitHub's default clone directory) but the portfolio layout uses desktop_terrarium/ (underscore, lowercase). A fresh clone following only the README lands in a different directory than the nested-repo layout expects. Either add a note pointing to docs/FIRST-BOOT-AND-NESTED-LAYOUT.md for portfolio-layout clones, or change the clone command to git clone https://github.com/saagpatel/DesktopTerrarium desktop_terrarium to match the canonical layout. This is a docs↔docs inconsistency; the code cannot arbitrate it.

Footer

  • Date/time: 2026-05-30 22:32:28 PDT
  • Branch: docs/truth-up-2026-05-30
  • HEAD sha reconciled against: 4def9cba4675dca65e09c451a580b256d5da8f54