Documentation Index

Repository-wide entrypoint for VT Code documentation.

Last reviewed: 2026-06-17

Start Here

• Documentation Hub - Main user/developer overview.
• Harness Index - Agent operating model, quality scoring, and debt tracking.
• Zen Alignment - Full all-19 principle mapping and rollout.
• Architecture - System structure and crate boundaries.
• Contributing - Contribution workflow and standards.

Core Domains

• Configuration Precedence - Runtime config loading order.
• Config Field Reference - Field-level schema reference.
• Scheduled Tasks - Session /loop polling, reminders, and durable scheduler flows.
• Permissions Guide - Granular agent permissions and rule grammar.
• Provider Guides - LLM provider setup and behavior.
• Security Model - Security architecture.
• Process Hardening - Runtime hardening controls.
• MCP Integration Guide - MCP integration onboarding.
• Testing Guide - Test strategy and commands.

Engineering References

• Development Setup - Canonical contributor setup and local quality loop.
• C++ Core Guidelines Adoption - Rules for C/C++ code paths and cross-language safety intent.
• Extension Boundaries - When to use internal Rust traits vs external protocol or manifest seams.
• Language Support Matrix - Tree-sitter and language support status.
• Signal Handling - Ctrl+C / SIGINT priority guarantees and emergency exit.
• Indexer Notes - Indexer behavior and usage.
• Development Guide - Local dev workflows.
• Roadmap - Planned work.

Module Documentation

• vtcode-ui - UI framework, design system, theme registry.
• vtcode-llm - LLM provider abstraction and streaming.
• vtcode-skills - Skill discovery, loading, and validation.
• vtcode-safety - Command safety, execution policies, sandboxing.
• vtcode-a2a - Agent2Agent protocol support.
• vtcode-mcp - Model Context Protocol integration.
• vtcode-bash-runner - Shell execution sandbox.
• vtcode-config - Configuration loading and schema.
• vtcode-commons - Shared utilities.
• vtcode-exec-events - ThreadEvent contract and ATIF export.
• vtcode-indexer - Code indexing and search.

Historical and Archive Paths

• docs/mcp/archive/ - Historical MCP implementation reports.
• docs/async/ - Async migration implementation logs.
• docs/vscode-extension-improve-docs/ - VS Code extension review artifacts.

When adding implementation summaries or one-off reports, prefer a domain folder or an archive path instead of placing files at docs/*.md.