Skip to content
This repository was archived by the owner on Sep 23, 2025. It is now read-only.

Commit 9c10188

Browse files
committed
Clean up documentation structure and fix outdated content
- Reorganize SUMMARY.md to be user-focused rather than RFC-heavy - Rewrite extension.md to match actual webview implementation (not fantasy tree view) - Remove outdated subsections (terminal-registry.md, markdown-rendering.md) - Convert tool interface docs to use mdbook includes with anchors to prevent staleness - Add user-friendly pages for IDE capabilities and code walkthroughs - Fix typos and improve cross-references in FAQ The documentation now accurately reflects the current implementation and uses patterns that prevent it from going stale.
1 parent d1c72e2 commit 9c10188

15 files changed

+132
-934
lines changed

β€Žmd/SUMMARY.mdβ€Ž

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
- [Installation](./installation.md) <!-- πŸ’‘: Step-by-step setup for both VSCode extension and MCP server components -->
1010
- [Quick start](./quick-start.md) <!-- πŸ’‘: Basic workflow example showing AI assistant β†’ review display β†’ navigation cycle -->
11-
- [Features]()
12-
- [Presenting a walkthrough](./walkthrough-presentation.md) <!-- πŸ’‘: Explain how presentation works, from a user's perspective -->
13-
- [Ask Socratic Shell](./ask-socratic-shell.md) <!-- πŸ’‘: Explain how Ask Socratic Shell works, from a user's perspective -->
11+
- [Features]() <!-- πŸ’‘: Explains how to use each feature -->
12+
- [Code walkthroughs and Ask Socratic Shell](./present-review.md) <!-- πŸ’‘: Give examples of how to ask the agent to walk through code with you, what happens when you click links, and how you can use Ask Socratic Shell. -->
13+
- [IDE Capabilities](./ide-capabilities.md) <!-- πŸ’‘: Natural language interface to VSCode/LSP features, current capabilities, and implementation details -->
1414
- [Review format](./review-format.md) <!-- πŸ’‘: Explains file:line syntax, reference-style links [file:line][], and markdown conventions AI assistants should follow -->
1515
- [Frequently asked questions](./faq.md) <!-- πŸ’‘: Anticipated user questions about common errors, expected workflow, purpose, comparisons with other tools, etc -->
1616

@@ -19,24 +19,17 @@
1919
- [Building and testing](./design/build-and-test.md) <!-- πŸ’‘: Development environment setup, build process, and testing procedures -->
2020
- [System overview](./design/overview.md) <!-- πŸ’‘: High-level architecture showing MCP server ↔ VSCode extension communication via Unix sockets -->
2121
- [Communication protocol](./design/protocol.md) <!-- πŸ’‘: JSON message format, Unix socket/named pipe IPC, and error handling between components -->
22-
- [Message flows](./design/message-flows.md) <!-- πŸ’‘: Detailed sequence diagrams and examples for review presentation and Ask Socratic Shell flows -->
23-
- [Daemon message bus](./design/daemon.md) <!-- πŸ’‘: Central message router implementation, client management, process lifecycle, and Unix socket server architecture -->
24-
- [MCP server](./design/mcp-server.md) <!-- πŸ’‘: AI assistant bridge implementation, process discovery, tool handlers, and daemon client functionality -->
2522
- [Security considerations](./design/security.md) <!-- πŸ’‘: CSP headers, DOMPurify sanitization, and secure webview practices for markdown rendering -->
26-
- [MCP Tool interface](./design/mcp-tool-interface.md) <!-- πŸ’‘: API specification for AI assistants calling present_review tool with markdown content -->
2723
- [AI Guidance design considerations](./design/ai-guidance.md) <!-- πŸ’‘: Design decisions made specifically to work well with AI collaboration patterns from socratic shell -->
24+
- [Codebase structure](./design/codebase-structure.md) <!-- πŸ’‘: Overview of project structure, key files, and how components connect for contributors -->
25+
- [How each feature works]() <!-- πŸ’‘: Walk through the flow of particular features -->
26+
- [Present Review](./design/present-review.md) <!-- πŸ’‘: How AI assistants present code reviews, message flows, and implementation details -->
27+
- [Ask Socratic Shell](./design/ask-socratic-shell.md) <!-- πŸ’‘: How Ask Socratic Shell works, message flows, and implementation details -->
28+
- [IDE Capabilities](./design/ide-capabilities.md) <!-- πŸ’‘: Natural language interface to VSCode/LSP features, current capabilities, and implementation details -->
29+
- [MCP server](./design/mcp-server.md) <!-- πŸ’‘: Highlights of the MCP server -->
30+
- [Daemon message bus](./design/daemon.md) <!-- πŸ’‘: Central message router implementation, client management, process lifecycle, and Unix socket server architecture -->
31+
- [MCP Tool interface](./design/mcp-tool-interface.md) <!-- πŸ’‘: API specification for AI assistants calling present_review tool with markdown content -->
2832
- [VSCode extension](./design/extension.md) <!-- πŸ’‘: Highlights of the VSCode Extension design and implementation: activation, establishing IPC protocol -->
29-
- [Terminal registry](./design/terminal-registry.md) <!-- πŸ’‘: Implementation details for tracking active MCP servers, PID discovery, and capability-based routing -->
30-
- [Markdown rendering](./design/markdown-rendering.md) <!-- πŸ’‘: markdown-it pipeline, custom renderer rules for file references, and HTML generation process -->
31-
32-
# In-progress RFCs <!-- πŸ’‘: Design proposals under active development and discussion -->
33-
34-
- [RFC: Exposing IDE capabilities](./rfcs/ide-capabilities/README.md) <!-- πŸ’‘: Proposal for natural language interface to VSCode and LSP features through composable JSON mini-language -->
35-
- [RFC: Scripting language](./rfcs/ide-capabilities/scripting-language.md) <!-- πŸ’‘: JSON mini-language design with function composition and value types -->
36-
- [RFC: Validation boundaries](./rfcs/ide-capabilities/scripting-language/validation-boundaries.md) <!-- πŸ’‘: Where should type checking happen - in the engine or in capability implementations? -->
37-
- [RFC: Ambiguity resolution](./rfcs/ide-capabilities/scripting-language/ambiguity-resolution.md) <!-- πŸ’‘: How functions like {"symbol":{"name":"foo"}} handle multiple matches -->
38-
- [RFC: Natural language interface](./rfcs/ide-capabilities/natural-language-interface.md) <!-- πŸ’‘: How natural language requests get converted to JSON programs -->
39-
- [RFC: Capability registry](./rfcs/ide-capabilities/capability-registry.md) <!-- πŸ’‘: What IDE capabilities to expose initially and their function signatures -->
4033

4134
# References
4235

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Ask Socratic Shell
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Codebase structure

0 commit comments

Comments
Β (0)