From d0dec98a185b92d335e33f4ae4ed528fa5b0b9b6 Mon Sep 17 00:00:00 2001 From: Ed_ Date: Wed, 10 Jun 2026 23:57:47 -0400 Subject: [PATCH] docs(readme): refresh file tree + summary table (27 guides with full alphabetical list, 45+1=46 MCP tools, 33 commands, shell_runner with patch_callback, 322 test files) --- docs/Readme.md | 53 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/docs/Readme.md b/docs/Readme.md index 4de81c37..c2c0390c 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -28,7 +28,7 @@ This documentation suite provides comprehensive technical reference for the Manu | [NERV Theme](guide_nerv_theme.md) | "Black Void" palette with NERV orange/red/green/blue accents, zero-rounding geometry, CRT-style visual effects (scanlines, status flickering, alert animations), `theme_nerv.py` and `theme_nerv_fx.py` modules, FBO shader pipeline, configuration keys, performance cost, accessibility caveats | | [Workspace Profiles](guide_workspace_profiles.md) | Docking layouts, window visibility, and per-panel state persistence, `WorkspaceProfile` schema (4 fields: `name`, `ini_content: str`, `show_windows`, `panel_states`), `WorkspaceManager` CRUD, scope inheritance (Global and Project), contextual auto-switch (experimental) binding profiles to MMA tier or task context, multi-monitor limitations | | [Command Palette](guide_command_palette.md) | Fuzzy command resolution with subsequence matching and scoring, async context preview worker to prevent UI hangs, "Everything" mode for cross-domain search (commands, files, symbols, history, settings), streaming results via thread-safe queue, cancellation on query change, 50+ built-in commands, user-defined commands via TOML | -| [Testing](guide_testing.md) | 273 test files, 5 test categories (unit, integration, live_gui, perf, simulation), 7 conftest fixtures (`isolate_workspace`, `reset_paths`, `reset_ai_client`, `vlogger`, `kill_process_tree`, `mock_app`, `live_gui` session-scoped), Hook API testing pattern, Puppeteer pattern for MMA simulation, mock provider strategy, opt-in clean install test, opt-in docker test, coverage targets, anti-patterns (no arbitrary core mocking, artifact isolation to `tests/artifacts/`), early-render C-level crash pattern (`_ini_capture_ready` defer-not-catch for `imgui.save_ini_settings_to_memory`), live_gui authoring contract (wait-for-ready pattern over `time.sleep`, narrow test paths over kitchen-sink `render_main_interface` mocks), test-ordering sensitivity (session-scoped fixture) | +| [Testing](guide_testing.md) | 322 test files, 5 test categories (unit, integration, live_gui, perf, simulation), 7 conftest fixtures (`isolate_workspace`, `reset_paths`, `reset_ai_client`, `vlogger`, `kill_process_tree`, `mock_app`, `live_gui` session-scoped), Hook API testing pattern, Puppeteer pattern for MMA simulation, mock provider strategy, opt-in clean install test, opt-in docker test, coverage targets, anti-patterns (no arbitrary core mocking, artifact isolation to `tests/artifacts/`), early-render C-level crash pattern (`_ini_capture_ready` defer-not-catch for `imgui.save_ini_settings_to_memory`), live_gui authoring contract (wait-for-ready pattern over `time.sleep`, narrow test paths over kitchen-sink `render_main_interface` mocks), test-ordering sensitivity (session-scoped fixture) | | [Themes](guide_themes.md) | TOML-based theming system: file layout (`themes/.toml` global + `project_themes.toml` per-project), schema (`syntax_palette` + `[colors]` table with `imgui.Col_` snake_case keys), 4-syntax-palette upstream limit (`imgui-bundle` ships `dark`/`light`/`mariana`/`retro_blue` only), built-in vs TOML palette dispatch, `load_themes_from_disk` / `get_syntax_palette_for_theme` / `apply_syntax_palette` public API, hot-reload behavior, color-callable convention (`C_LBL()` / `C_VAL()` for theme-aware helpers) | | [GUI Main](guide_gui_2.md) | `src/gui_2.py` reference: App class lifecycle, ~90 module-level render functions (UI Delegation Pattern), immgui immediate-mode rendering, Multi-Viewport docks, panel registry, command palette integration, ImGuiScope context managers, hot reload support, key bindings (Ctrl+Shift+P, Ctrl+Alt+R, Ctrl+Z/Y), `_capture_workspace_profile` defer-not-catch pattern (line 813-841, `_ini_capture_ready` flag for `imgui.save_ini_settings_to_memory`), theme color-callable pattern (e.g. `DIR_COLORS`/`KIND_COLORS` dicts store `C_VAL` not `C_VAL()` and are called at use site), `__getattr__` ui_ attrs hasattr-guard (bcdc26d0 silent-None fix), `_LazyModule` / `_FiledialogStub` lazy import proxies, `startup_profiler` + `render_warmup_status_indicator` integration, native `_detect_refresh_rate_win32` (ctypes.EnumDisplaySettingsW) | | [AI Client](guide_ai_client.md) | `src/ai_client.py` reference: multi-provider LLM singleton (5 providers: Gemini, Anthropic, DeepSeek, MiniMax, Gemini CLI), async dispatch with `asyncio.gather`, threading.local for source tier tagging, context caching (Anthropic ephemeral + Gemini explicit), system prompt assembly, error interception for Tier 4 QA | @@ -336,23 +336,34 @@ manual_slop/ │ ├── workflow.md │ ├── index.md │ └── edit_workflow.md -├── docs/ # Deep-dive documentation (24 guides + specs/plans) -│ ├── guide_architecture.md -│ ├── guide_meta_boundary.md -│ ├── guide_tools.md -│ ├── guide_mma.md -│ ├── guide_simulations.md -│ ├── guide_context_curation.md -│ ├── guide_shaders_and_window.md -│ ├── guide_rag.md -│ ├── guide_beads.md -│ ├── guide_hot_reload.md -│ ├── guide_personas.md -│ ├── guide_nerv_theme.md -│ ├── guide_workspace_profiles.md -│ ├── guide_command_palette.md -│ ├── guide_themes.md -│ ├── guide_testing.md +├── docs/ # Deep-dive documentation (27 guides + specs/plans) +│ ├── guide_ai_client.md # Multi-provider LLM client +│ ├── guide_api_hooks.md # HookServer + ApiHookClient +│ ├── guide_app_controller.md # Headless AppController +│ ├── guide_architecture.md # Threading, event system, state machines +│ ├── guide_beads.md # Beads/Dolt issue tracking +│ ├── guide_command_palette.md # Command palette + 33 registered commands +│ ├── guide_context_aggregation.md # aggregate.py pipeline (strategies + view modes) +│ ├── guide_context_curation.md # Granular AST control + Fuzzy Anchor slices +│ ├── guide_discussions.md # Discussion system + A1-A7 matrix +│ ├── guide_docker_deployment.md # Docker + Gitea registry deployment +│ ├── guide_gui_2.md # Main ImGui interface (App class, render functions) +│ ├── guide_hot_reload.md # State-preserving module reloading +│ ├── guide_mcp_client.md # 45 MCP tools + 3-layer security +│ ├── guide_meta_boundary.md # Application vs Meta-Tooling split +│ ├── guide_mma.md # 4-Tier MMA concepts +│ ├── guide_models.md # Data model registry +│ ├── guide_multi_agent_conductor.md # ConductorEngine + TrackDAG + WorkerPool +│ ├── guide_nerv_theme.md # NERV Tactical Console theme +│ ├── guide_personas.md # Unified agent profile system +│ ├── guide_rag.md # RAG subsystem (ChromaDB + embeddings) +│ ├── guide_shaders_and_window.md # Shader injection + custom window frame +│ ├── guide_simulations.md # Test framework + Puppeteer pattern +│ ├── guide_state_lifecycle.md # Undo/redo + state delegation +│ ├── guide_testing.md # 322 test files + 7 conftest fixtures +│ ├── guide_themes.md # Multi-theme TOML system +│ ├── guide_tools.md # MCP tools + shell runner +│ ├── guide_workspace_profiles.md # Workspace profile save/load │ ├── Readme.md │ ├── MMA_Support/ # Legacy MMA reference (deprecated) │ ├── reports/ # Phase 5 reports @@ -361,7 +372,7 @@ manual_slop/ │ ├── gui_2.py # Primary ImGui interface │ ├── app_controller.py # Headless controller │ ├── ai_client.py # Multi-provider LLM (Gemini, Anthropic, DeepSeek, MiniMax) -│ ├── mcp_client.py # 45 MCP tools with 3-layer security +│ ├── mcp_client.py # 45 MCP tools + 1 shell runner (canonical 46) with 3-layer security │ ├── api_hooks.py # HookServer REST API on :8999 │ ├── api_hook_client.py # Python client for the Hook API │ ├── multi_agent_conductor.py # ConductorEngine @@ -379,12 +390,12 @@ manual_slop/ │ ├── tool_presets.py # Tool preset manager │ ├── tool_bias.py # Tool bias engine │ ├── command_palette.py # Command palette + fuzzy matcher -│ ├── commands.py # 32 registered commands +│ ├── commands.py # 33 registered commands │ ├── workspace_manager.py # Workspace profile save/load │ ├── theme_2.py # Theme system (palette/font/etc.) │ ├── theme_nerv.py # NERV Tactical Console theme │ ├── theme_nerv_fx.py # NERV FX (scanlines, flicker, alert) -│ ├── shell_runner.py # PowerShell execution +│ ├── shell_runner.py # PowerShell execution with 60s timeout + qa_callback + patch_callback │ ├── file_cache.py # ASTParser (tree-sitter) │ ├── summarize.py # Heuristic file summaries │ ├── outline_tool.py # Hierarchical code outline