Location: src/vs/[path/to/component]
Type: [Service/Contribution/Extension/API/etc.]
Layer (if applicable): [base/platform/editor/workbench/code/server]
Purpose
Brief description of what this component does and why it exists.
Scope
- What functionality is included
- What is explicitly out of scope
- Integration points with other components
Architecture
High-Level Design
[Architectural diagram or description of key patterns used]
Key Classes & Interfaces
- [ClassName]: Brief description of responsibility
- [InterfaceName]: Purpose and main methods
- [ServiceName]: Service responsibilities
Key Files
List all the key files and a brief description of their purpose:
src/vs/[path/to/component]/[filename.ts]: [Purpose and main exports]src/vs/[path/to/component]/[service.ts]: [Service implementation details]src/vs/[path/to/component]/[contribution.ts]: [Workbench contributions]
Development Guidelines
- Reserve a section for any specific development practices or patterns relevant to this component. These will be edited by a developer or agent as needed.