You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Show an example of successful CLI validation output #34
The CLI and agent guide describes the expected counts and draft warning in prose. A small JSON excerpt would help new users compare their own output and tell that the draft warning is expected even when validation succeeds.
Scope
Add the excerpt below the commands in the Try the synthetic example section of docs/CLI.en.md. Use the checked-in examples/minimal workspace and keep the CLI, output format, and example files as they are.
Acceptance criteria
The excerpt comes from node ./dist/cli.js validate --workspace ./examples/minimal --json on a fresh build. Keep the actual JSON keys and show ok: true, the record and project counts, and the expected draft warning. Mark the excerpt as shortened if any fields are omitted.
One sentence explains what the warning means and what ok: true confirms.
Include the command result and the output of npm run check:docs in the PR.
AI-assisted scope note, based on reviewing the current CLI source and guide; no build or documentation checks have been run.
The validate handler already emits scope: "structure-and-references-only" alongside ok, records, projects, and warnings. Keeping that field in the captured example would make the limit of ok: true visible in the JSON itself, rather than only in the explanation below it.
A focused docs-only change could retain all five fields from the fresh synthetic-workspace run, including the draft warning, and explain that successful structural validation does not make a draft reviewed or eligible for export without --include-drafts. That keeps the example aligned with the existing export guidance without changing CLI behavior or fixtures.
The excerpt should be captured from the command in the acceptance criteria, not reconstructed from this source inspection. Would retaining the full five-field report be preferable to shortening it?
Good point. Thank you for comment!!
Let’s include all five fields from a fresh run of the command in the issue. Keeping scope makes it clear what ok: true covers, and showing the draft warning helps readers know what to expect when they run the example themselves.
Activity
Kin230k commentedon Nov 19, 2026
AI-assisted scope note, based on reviewing the current CLI source and guide; no build or documentation checks have been run.
The
validatehandler already emitsscope: "structure-and-references-only"alongsideok,records,projects, andwarnings. Keeping that field in the captured example would make the limit ofok: truevisible in the JSON itself, rather than only in the explanation below it.A focused docs-only change could retain all five fields from the fresh synthetic-workspace run, including the draft warning, and explain that successful structural validation does not make a draft reviewed or eligible for export without
--include-drafts. That keeps the example aligned with the existing export guidance without changing CLI behavior or fixtures.The excerpt should be captured from the command in the acceptance criteria, not reconstructed from this source inspection. Would retaining the full five-field report be preferable to shortening it?
OstenHun commentedon Nov 19, 2026
Good point. Thank you for comment!!
Let’s include all five fields from a fresh run of the command in the issue. Keeping scope makes it clear what ok: true covers, and showing the draft warning helps readers know what to expect when they run the example themselves.