|
8 | 8 |
|
9 | 9 | - [Installation](./installation.md) <!-- π‘: Step-by-step setup for both VSCode extension and MCP server components --> |
10 | 10 | - [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 --> |
14 | 14 | - [Review format](./review-format.md) <!-- π‘: Explains file:line syntax, reference-style links [file:line][], and markdown conventions AI assistants should follow --> |
15 | 15 | - [Frequently asked questions](./faq.md) <!-- π‘: Anticipated user questions about common errors, expected workflow, purpose, comparisons with other tools, etc --> |
16 | 16 |
|
|
19 | 19 | - [Building and testing](./design/build-and-test.md) <!-- π‘: Development environment setup, build process, and testing procedures --> |
20 | 20 | - [System overview](./design/overview.md) <!-- π‘: High-level architecture showing MCP server β VSCode extension communication via Unix sockets --> |
21 | 21 | - [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 --> |
25 | 22 | - [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 --> |
27 | 23 | - [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 --> |
28 | 32 | - [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 --> |
40 | 33 |
|
41 | 34 | # References |
42 | 35 |
|
|
0 commit comments