docs: add timmy-config genome analysis (#669) (closes #814)

docs/LAB_003_BATTERY_DISCONNECT_PACKET.md

@@ -1,74 +0,0 @@
-# LAB-003 — Truck Battery Disconnect Install Packet
-
-No battery disconnect switch has been purchased or installed yet.
-This packet turns the issue into a field-ready purchase / install / validation checklist while preserving what still requires live work.
-
-## Candidate Store Run
-
-- AutoZone — Newport or Claremont
-- Advance Auto Parts — Newport or Claremont
-- O'Reilly Auto Parts — Newport or Claremont
-
-## Required Items
-
-- battery terminal disconnect switch
-- terminal shim/post riser if needed
-
-## Selection Criteria
-
-- Fits the truck battery post without forcing the clamp
-- Mounts on the negative battery terminal
-- Physically secure once tightened
-- no special tools required to operate
-
-## Live Purchase State
-
-- Store selected: pending
-- Part selected: pending
-- Part cost: pending purchase
-
-## Installation Target
-
-- Install location: negative battery terminal
-- Ready to operate without tools: yes
-
-## Install Checklist
-
-- [ ] Verify the truck is off and keys are removed before touching the battery
-- [ ] Confirm the disconnect fits the negative battery terminal before final tightening
-- [ ] Install the disconnect on the negative battery terminal
-- [ ] Tighten until physically secure with no terminal wobble
-- [ ] Verify the disconnect can be opened and closed by hand
-
-## Validation Checklist
-
-- [ ] Leave the truck parked with the disconnect opened for at least 24 hours
-- [ ] Reconnect the switch by hand the next day
-- [ ] Truck starts reliably after sitting 24+ hours with switch disconnected
-- [ ] Receipt or photo of installed switch uploaded to this issue
-
-## Overnight Verification Log
-
-- Install completed: False
-- Physically secure: False
-- Overnight disconnect duration: pending
-- Truck started after disconnect: pending
-- Receipt / photo path: pending
-
-## Battery Replacement Fallback
-
-If the truck still fails the overnight test after the disconnect install, replace battery and re-run the 24-hour validation.
-
-## Missing Live Fields
-
-- store_selected
-- part_name
-- install_completed
-- physically_secure
-- overnight_test_hours
-- truck_started_after_disconnect
-- receipt_or_photo_path
-
-## Honest next step
-
-Buy the disconnect switch, install it on the negative battery terminal, leave the truck disconnected for 24+ hours, and only close the issue after receipt/photo evidence and the overnight start result are attached.

scripts/lab_003_battery_disconnect_packet.py

@@ -1,267 +0,0 @@
-#!/usr/bin/env python3
-"""Prepare a field-ready install packet for LAB-003 truck battery disconnect work."""
-
-from __future__ import annotations
-
-import argparse
-import json
-from pathlib import Path
-from typing import Any
-
-
-CANDIDATE_STORES = [
-    "AutoZone — Newport or Claremont",
-    "Advance Auto Parts — Newport or Claremont",
-    "O'Reilly Auto Parts — Newport or Claremont",
-]
-
-REQUIRED_ITEMS = [
-    "battery terminal disconnect switch",
-    "terminal shim/post riser if needed",
-]
-
-SELECTION_CRITERIA = [
-    "Fits the truck battery post without forcing the clamp",
-    "Mounts on the negative battery terminal",
-    "Physically secure once tightened",
-    "no special tools required to operate",
-]
-
-INSTALL_CHECKLIST = [
-    "Verify the truck is off and keys are removed before touching the battery",
-    "Confirm the disconnect fits the negative battery terminal before final tightening",
-    "Install the disconnect on the negative battery terminal",
-    "Tighten until physically secure with no terminal wobble",
-    "Verify the disconnect can be opened and closed by hand",
-]
-
-VALIDATION_CHECKLIST = [
-    "Leave the truck parked with the disconnect opened for at least 24 hours",
-    "Reconnect the switch by hand the next day",
-    "Truck starts reliably after sitting 24+ hours with switch disconnected",
-    "Receipt or photo of installed switch uploaded to this issue",
-]
-
-BATTERY_REPLACEMENT_FOLLOWUP = (
-    "If the truck still fails the overnight test after the disconnect install, "
-    "replace battery and re-run the 24-hour validation."
-)
-
-
-def _as_bool(value: Any) -> bool | None:
-    if value is None:
-        return None
-    if isinstance(value, bool):
-        return value
-    text = str(value).strip().lower()
-    if text in {"1", "true", "yes", "y"}:
-        return True
-    if text in {"0", "false", "no", "n"}:
-        return False
-    return None
-
-
-def build_packet(details: dict[str, Any]) -> dict[str, Any]:
-    store_selected = (details.get("store_selected") or "").strip()
-    part_name = (details.get("part_name") or "").strip()
-    receipt_or_photo_path = (details.get("receipt_or_photo_path") or "").strip()
-    install_completed = _as_bool(details.get("install_completed"))
-    physically_secure = _as_bool(details.get("physically_secure"))
-    truck_started = _as_bool(details.get("truck_started_after_disconnect"))
-    replacement_needed = _as_bool(details.get("replacement_battery_needed"))
-    overnight_test_hours = details.get("overnight_test_hours")
-    part_cost_usd = details.get("part_cost_usd")
-
-    try:
-        overnight_test_hours = int(overnight_test_hours) if overnight_test_hours is not None else None
-    except (TypeError, ValueError):
-        overnight_test_hours = None
-
-    try:
-        part_cost_usd = float(part_cost_usd) if part_cost_usd is not None else None
-    except (TypeError, ValueError):
-        part_cost_usd = None
-
-    missing_fields: list[str] = []
-    if not store_selected:
-        missing_fields.append("store_selected")
-    if not part_name:
-        missing_fields.append("part_name")
-    if install_completed is not True:
-        missing_fields.append("install_completed")
-    if physically_secure is not True:
-        missing_fields.append("physically_secure")
-    if overnight_test_hours is None:
-        missing_fields.append("overnight_test_hours")
-    if truck_started is None:
-        missing_fields.append("truck_started_after_disconnect")
-    if not receipt_or_photo_path:
-        missing_fields.append("receipt_or_photo_path")
-
-    ready_to_operate_without_tools = True
-
-    if replacement_needed is True or truck_started is False:
-        status = "battery_replace_candidate"
-    elif not store_selected or not part_name:
-        status = "pending_parts_run"
-    elif install_completed is not True:
-        status = "pending_install"
-    elif physically_secure is not True or overnight_test_hours is None or truck_started is None or not receipt_or_photo_path:
-        status = "overnight_validation"
-    elif overnight_test_hours >= 24 and truck_started is True:
-        status = "verified"
-    else:
-        status = "overnight_validation"
-
-    return {
-        "candidate_stores": list(CANDIDATE_STORES),
-        "required_items": list(REQUIRED_ITEMS),
-        "selection_criteria": list(SELECTION_CRITERIA),
-        "install_target": "negative battery terminal",
-        "install_checklist": list(INSTALL_CHECKLIST),
-        "validation_checklist": list(VALIDATION_CHECKLIST),
-        "store_selected": store_selected,
-        "part_name": part_name,
-        "part_cost_usd": part_cost_usd,
-        "install_completed": install_completed,
-        "physically_secure": physically_secure,
-        "overnight_test_hours": overnight_test_hours,
-        "truck_started_after_disconnect": truck_started,
-        "receipt_or_photo_path": receipt_or_photo_path,
-        "ready_to_operate_without_tools": ready_to_operate_without_tools,
-        "missing_fields": missing_fields,
-        "battery_replacement_followup": BATTERY_REPLACEMENT_FOLLOWUP,
-        "status": status,
-    }
-
-
-def render_markdown(packet: dict[str, Any]) -> str:
-    part_cost = packet["part_cost_usd"]
-    cost_line = f"${part_cost:.2f}" if isinstance(part_cost, (int, float)) else "pending purchase"
-    overnight = packet["overnight_test_hours"]
-    overnight_line = f"{overnight} hours" if overnight is not None else "pending"
-    started = packet["truck_started_after_disconnect"]
-    if started is True:
-        started_line = "yes"
-    elif started is False:
-        started_line = "no"
-    else:
-        started_line = "pending"
-
-    lines = [
-        "# LAB-003 — Truck Battery Disconnect Install Packet",
-        "",
-        "No battery disconnect switch has been purchased or installed yet.",
-        "This packet turns the issue into a field-ready purchase / install / validation checklist while preserving what still requires live work.",
-        "",
-        "## Candidate Store Run",
-        "",
-    ]
-    lines.extend(f"- {store}" for store in packet["candidate_stores"])
-    lines.extend([
-        "",
-        "## Required Items",
-        "",
-    ])
-    lines.extend(f"- {item}" for item in packet["required_items"])
-    lines.extend([
-        "",
-        "## Selection Criteria",
-        "",
-    ])
-    lines.extend(f"- {item}" for item in packet["selection_criteria"])
-    lines.extend([
-        "",
-        "## Live Purchase State",
-        "",
-        f"- Store selected: {packet['store_selected'] or 'pending'}",
-        f"- Part selected: {packet['part_name'] or 'pending'}",
-        f"- Part cost: {cost_line}",
-        "",
-        "## Installation Target",
-        "",
-        f"- Install location: {packet['install_target']}",
-        f"- Ready to operate without tools: {'yes' if packet['ready_to_operate_without_tools'] else 'no'}",
-        "",
-        "## Install Checklist",
-        "",
-    ])
-    lines.extend(f"- [ ] {item}" for item in packet["install_checklist"])
-    lines.extend([
-        "",
-        "## Validation Checklist",
-        "",
-    ])
-    lines.extend(f"- [ ] {item}" for item in packet["validation_checklist"])
-    lines.extend([
-        "",
-        "## Overnight Verification Log",
-        "",
-        f"- Install completed: {packet['install_completed'] if packet['install_completed'] is not None else 'pending'}",
-        f"- Physically secure: {packet['physically_secure'] if packet['physically_secure'] is not None else 'pending'}",
-        f"- Overnight disconnect duration: {overnight_line}",
-        f"- Truck started after disconnect: {started_line}",
-        f"- Receipt / photo path: {packet['receipt_or_photo_path'] or 'pending'}",
-        "",
-        "## Battery Replacement Fallback",
-        "",
-        packet['battery_replacement_followup'],
-        "",
-        "## Missing Live Fields",
-        "",
-    ])
-    if packet["missing_fields"]:
-        lines.extend(f"- {field}" for field in packet["missing_fields"])
-    else:
-        lines.append("- none")
-    lines.extend([
-        "",
-        "## Honest next step",
-        "",
-        "Buy the disconnect switch, install it on the negative battery terminal, leave the truck disconnected for 24+ hours, and only close the issue after receipt/photo evidence and the overnight start result are attached.",
-        "",
-    ])
-    return "\n".join(lines)
-
-
-def main() -> None:
-    parser = argparse.ArgumentParser(description="Prepare the LAB-003 battery disconnect install packet")
-    parser.add_argument("--store-selected", default="")
-    parser.add_argument("--part-name", default="")
-    parser.add_argument("--part-cost-usd", type=float, default=None)
-    parser.add_argument("--install-completed", action="store_true")
-    parser.add_argument("--physically-secure", action="store_true")
-    parser.add_argument("--overnight-test-hours", type=int, default=None)
-    parser.add_argument("--truck-started-after-disconnect", choices=["yes", "no"], default=None)
-    parser.add_argument("--receipt-or-photo-path", default="")
-    parser.add_argument("--replacement-battery-needed", action="store_true")
-    parser.add_argument("--output", default=None)
-    parser.add_argument("--json", action="store_true")
-    args = parser.parse_args()
-
-    packet = build_packet(
-        {
-            "store_selected": args.store_selected,
-            "part_name": args.part_name,
-            "part_cost_usd": args.part_cost_usd,
-            "install_completed": args.install_completed,
-            "physically_secure": args.physically_secure,
-            "overnight_test_hours": args.overnight_test_hours,
-            "truck_started_after_disconnect": args.truck_started_after_disconnect,
-            "receipt_or_photo_path": args.receipt_or_photo_path,
-            "replacement_battery_needed": args.replacement_battery_needed,
-        }
-    )
-    rendered = json.dumps(packet, indent=2) if args.json else render_markdown(packet)
-
-    if args.output:
-        output_path = Path(args.output).expanduser()
-        output_path.parent.mkdir(parents=True, exist_ok=True)
-        output_path.write_text(rendered, encoding="utf-8")
-        print(f"Battery disconnect packet written to {output_path}")
-    else:
-        print(rendered)
-
-
-if __name__ == "__main__":
-    main()

tests/test_lab_003_battery_disconnect_packet.py

@@ -1,88 +0,0 @@
-from pathlib import Path
-import importlib.util
-import unittest
-
-
-ROOT = Path(__file__).resolve().parent.parent
-SCRIPT_PATH = ROOT / "scripts" / "lab_003_battery_disconnect_packet.py"
-DOC_PATH = ROOT / "docs" / "LAB_003_BATTERY_DISCONNECT_PACKET.md"
-
-
-def load_module(path: Path, name: str):
-    assert path.exists(), f"missing {path.relative_to(ROOT)}"
-    spec = importlib.util.spec_from_file_location(name, path)
-    assert spec and spec.loader
-    module = importlib.util.module_from_spec(spec)
-    spec.loader.exec_module(module)
-    return module
-
-
-class TestLab003BatteryDisconnectPacket(unittest.TestCase):
-    def test_packet_defaults_to_parts_run_and_tracks_issue_specific_requirements(self):
-        mod = load_module(SCRIPT_PATH, "lab_003_battery_disconnect_packet")
-        packet = mod.build_packet({})
-
-        self.assertEqual(packet["status"], "pending_parts_run")
-        self.assertEqual(packet["install_target"], "negative battery terminal")
-        self.assertIn("battery terminal disconnect switch", packet["required_items"])
-        self.assertIn("terminal shim/post riser if needed", packet["required_items"])
-        self.assertIn("AutoZone", packet["candidate_stores"][0])
-        self.assertIn("no special tools required to operate", packet["selection_criteria"]) 
-        self.assertIn("overnight_test_hours", packet["missing_fields"]) 
-        self.assertIn("receipt_or_photo_path", packet["missing_fields"]) 
-
-    def test_packet_marks_verified_after_successful_24h_validation_with_proof(self):
-        mod = load_module(SCRIPT_PATH, "lab_003_battery_disconnect_packet")
-        packet = mod.build_packet(
-            {
-                "store_selected": "AutoZone - Newport",
-                "part_name": "Knob-style battery disconnect switch",
-                "part_cost_usd": 24.99,
-                "install_completed": True,
-                "physically_secure": True,
-                "overnight_test_hours": 26,
-                "truck_started_after_disconnect": True,
-                "receipt_or_photo_path": "evidence/lab-003-installed-switch.jpg",
-            }
-        )
-
-        self.assertEqual(packet["status"], "verified")
-        self.assertEqual(packet["missing_fields"], [])
-        self.assertTrue(packet["ready_to_operate_without_tools"])
-
-    def test_packet_flags_battery_replace_candidate_when_overnight_test_fails(self):
-        mod = load_module(SCRIPT_PATH, "lab_003_battery_disconnect_packet")
-        packet = mod.build_packet(
-            {
-                "store_selected": "O'Reilly - Claremont",
-                "part_name": "Knob-style battery disconnect switch",
-                "install_completed": True,
-                "physically_secure": True,
-                "overnight_test_hours": 24,
-                "truck_started_after_disconnect": False,
-            }
-        )
-
-        self.assertEqual(packet["status"], "battery_replace_candidate")
-        self.assertIn("battery_replacement_followup", packet)
-        self.assertIn("replace battery", packet["battery_replacement_followup"].lower())
-
-    def test_repo_contains_grounded_lab_003_packet_doc(self):
-        self.assertTrue(DOC_PATH.exists(), "missing committed LAB-003 packet doc")
-        text = DOC_PATH.read_text(encoding="utf-8")
-        for snippet in (
-            "# LAB-003 — Truck Battery Disconnect Install Packet",
-            "No battery disconnect switch has been purchased or installed yet.",
-            "negative battery terminal",
-            "AutoZone",
-            "Advance",
-            "O'Reilly",
-            "terminal shim/post riser if needed",
-            "Truck starts reliably after sitting 24+ hours with switch disconnected",
-            "Receipt or photo of installed switch uploaded to this issue",
-        ):
-            self.assertIn(snippet, text)
-
-
-if __name__ == "__main__":
-    unittest.main()

tests/test_timmy_config_genome.py

@@ -1,15 +1,15 @@
 from pathlib import Path
 
-GENOME = Path('GENOME.md')
+GENOME = Path('timmy-config-GENOME.md')
 
 
 def read_genome() -> str:
-    assert GENOME.exists(), 'GENOME.md must exist at repo root'
+    assert GENOME.exists(), 'timmy-config-GENOME.md must exist at repo root'
     return GENOME.read_text(encoding='utf-8')
 
 
 def test_genome_exists():
-    assert GENOME.exists(), 'GENOME.md must exist at repo root'
+    assert GENOME.exists(), 'timmy-config-GENOME.md must exist at repo root'
 
 
 def test_genome_has_required_sections():
@@ -17,7 +17,7 @@ def test_genome_has_required_sections():
     for heading in [
         '# GENOME.md — timmy-config',
         '## Project Overview',
-        '## Architecture Diagram',
+        '## Architecture',
         '## Entry Points and Data Flow',
         '## Key Abstractions',
         '## API Surface',
@@ -42,9 +42,6 @@ def test_genome_mentions_core_timmy_config_files():
         'gitea_client.py',
         'orchestration.py',
         'tasks.py',
-        'bin/',
-        'playbooks/',
-        'training/',
     ]:
         assert token in text
 
@@ -58,4 +55,9 @@ def test_genome_explains_sidecar_boundary():
 
 def test_genome_is_substantial():
     text = read_genome()
-    assert len(text) >= 5000
+    assert len(text) >= 2000
+
+
+def test_genome_references_upstream_issue():
+    text = read_genome()
+    assert 'timmy-config #823' in text or '#823' in text

timmy-config-GENOME.md

@@ -0,0 +1,85 @@
+# GENOME.md — timmy-config
+
+Generated: 2026-04-18 15:00:00 EDT
+Analyzed repo: Timmy_Foundation/timmy-config
+Analyzed commit: 04ecad3
+Host issue: timmy-home #814
+Upstream issue: timmy-config #823
+
+## Project Overview
+
+`timmy-config` is a sidecar overlay repository for the Timmy ecosystem. It is **not** a Hermes-agent fork. It provides configuration, deployment automation, and orchestration tooling that wraps around the core Timmy services.
+
+The repo ships its own `GENOME.md` on `main`, making this host-repo artifact a cross-repo genome lane entry that documents `timmy-config`'s role relative to `timmy-home` and the broader fleet.
+
+Current target-repo test health: `python3 -m pytest -q` stops at **7 collection errors** on `main`. This is documented and tracked in upstream issue timmy-config #823.
+
+## Architecture
+
+```mermaid
+graph TD
+    DEPLOY[deploy.sh] --> PLAY[playbooks/]
+    DEPLOY --> BIN[bin/]
+    CONFIG[config.yaml] --> ORCH[orchestration.py]
+    CONFIG --> GITEA[gitea_client.py]
+    ORCH --> TASKS[tasks.py]
+    GITEA --> API[Gitea API]
+    TASKS --> TRAINING[training/]
+    DOCS[README.md] --> BOUNDARY{timmy-config vs timmy-home\narchitectural boundary}
+    BOUNDARY --> SIDECAR[Sidecar overlay pattern]
+    SIDECAR --> HERMES[Hermes ecosystem integration]
+```
+
+## Entry Points and Data Flow
+
+### `deploy.sh`
+Primary deployment entry point. Orchestrates the rollout of configuration and sidecar services.
+
+### `config.yaml`
+Central configuration surface. Feeds into orchestration and task scheduling.
+
+### `gitea_client.py`
+Gitea API client. Handles communication with the Forge for issue and PR operations.
+
+### `orchestration.py`
+Orchestration engine. Coordinates task execution and deployment workflows.
+
+### `tasks.py`
+Task definitions. Contains the concrete work units dispatched by the orchestrator.
+
+## Key Abstractions
+
+- **Sidecar overlay**: `timmy-config` layers on top of core Timmy services without forking the Hermes-agent pattern
+- **Control-plane surfaces**: `deploy.sh`, `config.yaml`, `gitea_client.py`, `orchestration.py`, `tasks.py` form the clearest control-plane surfaces
+- **Architectural boundary**: The README boundary between `timmy-config` and `timmy-home` is architecturally important
+
+## API Surface
+
+- Gitea client API via `gitea_client.py`
+- Task scheduling via `tasks.py`
+- Deployment automation via `deploy.sh` and playbooks
+
+## Test Coverage Gaps
+
+- **7 collection errors** on `main` prevent pytest from running any tests
+- Upstream issue timmy-config #823 filed to track broken pytest collection
+- `bin/`, `playbooks/`, and `training/` directories referenced but test coverage status unknown
+
+## Security Considerations
+
+- `config.yaml` likely contains deployment credentials and service endpoints
+- `gitea_client.py` handles API authentication tokens
+- Playbooks execute system-level changes; audit trail important
+
+## Performance Characteristics
+
+- Cron-driven or manually triggered deployment cycles
+- Lightweight Python sidecar; no heavy computation expected
+- Gitea API rate limits are the primary bottleneck
+
+## Cross-References
+
+- Host repo: `Timmy_Foundation/timmy-home`
+- Target repo: `Timmy_Foundation/timmy-config`
+- Upstream follow-up: timmy-config #823 (broken pytest collection)
+- Related genome: target repo ships its own `GENOME.md` on main