Skip to content

docs(run): document the vix run architecture #727

Description

@GaspardKirira

Summary

Document the final architecture, supported inputs, dependency resolution,
planning, build integration, process lifecycle, watch mode, and compatibility
behavior.

Documentation sections

  • supported input kinds;
  • request and plan models;
  • automatic dependency resolution;
  • direct compilation;
  • CMake fallback;
  • project execution;
  • executable artifact resolution;
  • runtime arguments and environment;
  • process lifecycle;
  • sanitizers;
  • watch mode;
  • replay;
  • exit codes;
  • JSON events;
  • migration from removed options.

Acceptance criteria

  • Architecture documentation is available.
  • CLI examples are included.
  • Automatic dependency resolution is explained.
  • Removed --auto-deps options are documented.
  • Watch lifecycle is explained.
  • Platform differences are documented.
  • Documentation matches vix run --help.

Metadata

Metadata

Assignees

No one assigned

    Labels

    scope:docsDocumentation scopescope:runVix issue classificationtype:docsDocumentation only

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions