Documentation

Documentation

Start with installation, move through guides, and use the reference when you need exact behavior.

Vectron documentation is split into onboarding, the main vectron workflow, the vectron stack workflow, concrete examples for both configuration files, exact reference material, and contributor-facing sections.

Start with Start if you are new to the project. Use Vectron for process orchestration with vectron.toml, Vectron examples for realistic vectron.toml shapes, Stack for vectron stack, and Stack examples for realistic vectron.stack.toml configurations. Use Reference when you need exact field behavior and defaults.

Subsections

  • Start - Install Vectron, run the example config, and understand the smallest useful setup.
  • Vectron - Use `vectron.toml` to orchestrate local processes with guides, examples, and exact reference material.
  • Vectron Stack - Document the local `vectron stack` scaffolding flow and its current limits.
  • Reference - Exact command and configuration behavior for Vectron.
  • Internals - Contributor-facing architecture and runtime model documentation.
  • Project - Contribution, security, and roadmap information for the Vectron project.