-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority:P2
Description
Goal
Provide contributors with a clear mental model of the extension’s structure and coding conventions.
Acceptance Criteria
- New file
docs/architecture.mdcovering:- High‑level layers: Commands → Services → CLI / VS Code API → Utils.
- Dependency Injection pattern (service registry, how to mock).
- Error flow (StepZenError hierarchy + handler).
- Logging setup and log‑level setting.
- Testing strategy (Mocha + @vscode/test‑cli + mocks).
- Future roadmap hooks (telemetry, language server).
- README “Contributing” section links to the new doc.
- Doc renders correctly on GitHub (check tables, code fences).
- Commit:
docs: add architecture guide & link from README.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationpriority:P2