Skip to content

Docs: document vg doctor checks and CI exit semantics #262

Description

@vibgrate-team

Context

vg doctor is the natural “is this install healthy?” entry point for new users and CI images. Public docs should list what it checks, which exits mean “fix your environment,” and how it relates to vg build / vg scan without duplicating the full exit-code matrix already tracked elsewhere (#234).

What to do

  1. Document each doctor check category at a high level (runtime, grammars, graph cache, optional modules).
  2. Document exit code expectations for CI (pass vs actionable fail).
  3. Short vg doctor snippet; local-first; no secrets.

Acceptance

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions