-
Notifications
You must be signed in to change notification settings - Fork 0
Improve JSON diagnostics snippets in README and spec #4
Copy link
Copy link
Open
Labels
diagnosticshuman-readable and machine-readable diagnosticshuman-readable and machine-readable diagnosticsdocumentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is needed
Description
Summary
Tighten the JSON diagnostics examples in README.md and spec/diagnostics.md so they are easier to skim and more obviously consistent with the CLI.
Why this matters
Machine-readable diagnostics are one of OrgScript's strongest practical features, but they need short, clean examples for contributors and tool builders.
Scope
- review JSON snippets in
README.md - review JSON snippets in
spec/diagnostics.md - make examples shorter and easier to compare
- keep them faithful to real CLI output
Definition of done
- README and spec use consistent example structure
- snippets remain aligned with actual CLI behavior
- wording is concise and contributor-friendly
Notes
This issue is documentation-heavy but benefits from someone who can read the current diagnostics output carefully.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
diagnosticshuman-readable and machine-readable diagnosticshuman-readable and machine-readable diagnosticsdocumentationImprovements or additions to documentationImprovements or additions to documentationhelp wantedExtra attention is neededExtra attention is needed