Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Improve JSON diagnostics snippets in README and spec #4

Open
Labels
diagnosticshuman-readable and machine-readable diagnostics documentationImprovements or additions to documentation help wantedExtra 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    diagnosticshuman-readable and machine-readable diagnostics documentationImprovements or additions to documentation help wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

        AltStyle によって変換されたページ (->オリジナル) /