Skip to content

Document validation artifact examples in the README #4

@human-again

Description

@human-again

Goal

Make it easier for new users to understand the files Orbit writes after a run.

Suggested scope

  • Add a short README section showing example artifact paths such as agent-result.json, evaluation.json, and review.json.
  • Explain what each artifact proves.
  • Keep the section concise and linked to existing demos where possible.

Acceptance criteria

  • The README names the key artifacts and their purpose.
  • The wording reinforces that validation evidence matters more than self-reported success.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions