Skip to content

Add example JSON and Markdown output snippets to the Quick Start #30

@hudsonaikins

Description

@hudsonaikins

Problem

The Quick Start shows command examples, but it does not yet include short JSON or Markdown output snippets that help a new user understand what simulate and compare produce before they install the tool.

Scope

  • add concise output snippets for at least one simulate and one compare example
  • keep the examples stable and small enough to maintain
  • make sure the docs still read well in the repository UI

Acceptance Criteria

  • Quick Start includes example output snippets
  • docs stay accurate for the current public release
  • the work stays docs-only and contributor-friendly

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions