Skip to content

Docs: document vg review findings-from-diff JSON contract (kind: correctness) #231

Description

@vibgrate-team

Context

vg review findings-from-diff --format json now emits architecture-policy rows alongside blast-radius findings as kind: correctness. Integrators need a stable field contract so CI parsers do not guess.

What to do

  1. Document the JSON shape: top-level fields, finding object fields, and the meaning of kind values (at least blast-radius vs correctness / architecture-policy).
  2. Note determinism: same tree + same --diff (or current change) → same ordered JSON.
  3. Provide a minimal example snippet and point at actionable error cases (missing graph, empty diff).

Acceptance

  • Public docs describe the JSON contract including kind: correctness
  • Explicit determinism / stable-order note
  • Example uses vg review findings-from-diff --format json
  • DCO sign-off on the PR

Refs: #163 (broader output contracts) · release https://github.com/vibgrate/cli/releases/tag/v2026.917.1

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 documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions