This documentation covers the current development workflow for Vector. If you are contributing to the repository, start here before diving into feature work.
The docs are organized by the part of the project they explain.
This section covers local setup, environment variables, and everyday development commands.
2. Product
This section explains the product, who it is for, and the main workflows it supports.
3. Architecture
This section gives a high-level view of the stack, project structure, permissions model, and storage flow.
4. Development
This section contains developer conventions for coding style, routing, type safety, component usage, and error handling.
Useful debug guide:
5. Design
This section outlines the UI patterns and design principles used across the app.
This section records major technical decisions and the reasoning behind them.
- Prefer the getting-started guides and top-level repository docs for onboarding.
- The
docs/migration/directory is historical reference material from earlier architecture work and may not match the current contributor setup. - Some plan and implementation-summary files under
docs/development/are historical notes rather than onboarding docs. Prefer the numbered guides in each section first. - For contribution workflow, see CONTRIBUTING.md.