2.7 KiB
2.7 KiB
Implementation Plan: Deep Architectural Documentation Refresh
Phase 1: Context Cleanup & Research
- Task: Audit references to
MainContext.mdacross the project. - Task: Delete
MainContext.mdand update any identified references. - Task: Execute
py_get_skeletonandpy_get_code_outlineforevents.py,api_hooks.py,api_hook_client.py, andgui_2.pyto create a technical map for the guides. - Task: Analyze the
live_guifixture intests/conftest.pyand the simulation loop intests/visual_sim_mma_v2.py.
Phase 2: Core Architecture Deep Dive
Update docs/guide_architecture.md with expert-level detail.
- Task: Document the Dual-Threaded App Lifetime: Main GUI loop vs. Daemon execution threads.
- Task: Detail the
AsyncEventQueueandEventEmitterroles in the decoupling strategy. - Task: Explain the
_pending_gui_taskssynchronization mechanism for bridging the Hook Server and GUI. - Task: Document the "Linear Execution Clutch" and its deterministic state machine.
- Task: Verify the architectural descriptions against the actual implementation.
- Task: Conductor - User Manual Verification 'Phase 2: Core Architecture Deep Dive' (Protocol in workflow.md)
Phase 3: Hook System & Tooling Technical Reference
Update docs/guide_tools.md to include low-level API details.
- Task: Create a comprehensive API reference for all
HookServerendpoints. - Task: Document the
ApiHookClientimplementation, including retries and polling strategies. - Task: Update the MCP toolset guide with current native tool implementations.
- Task: Document the
ask/respondIPC flow for "Human-in-the-Loop" confirmations. - Task: Conductor - User Manual Verification 'Phase 3: Hook System & Tooling Technical Reference' (Protocol in workflow.md)
Phase 4: Verification & Simulation Framework
Create the new docs/guide_simulations.md guide.
- Task: Detail the Live GUI testing infrastructure:
--enable-test-hooksand thelive_guifixture. - Task: Breakdown the Simulation Lifecycle: Startup, Polling, Interaction, and Assertion.
- Task: Document the mock provider strategy using
tests/mock_gemini_cli.py. - Task: Provide examples of visual verification tests (e.g., MMA lifecycle).
- Task: Conductor - User Manual Verification 'Phase 4: Verification & Simulation Framework' (Protocol in workflow.md)
Phase 5: README & Roadmap Update
- Task: Update
Readme.mdwith current setup (uv,credentials.toml) and vision. - Task: Perform a project-wide link validation of all Markdown files.
- Task: Verify the high-density information style across all documentation.
- Task: Conductor - User Manual Verification 'Phase 5: README & Roadmap Update' (Protocol in workflow.md)