Skip to content

Improve README quickstart for first-time users #45

@kmadan

Description

@kmadan

Goal

Make the README quickstart frictionless for someone who has never seen AICertify before. They should be able to run an evaluation and look at a report within five minutes.

Why this matters

The README quickstart currently assumes the reader knows what a 'contract' is, that OPA is in the picture, and that they want a PDF report. New visitors need a shorter ladder.

Files likely involved

  • README.md (Quick Start section)
  • Possibly examples/quickstart.py (small clarifications)
  • Possibly docs/INDEX.md

Acceptance criteria

  • A copy-paste quickstart that runs to a generated report in under five commands
  • One screenshot or short PDF link of the resulting report visible inline
  • No assumed OPA or Rego knowledge for the first run
  • An explicit 'Now adapt it' callout pointing at the example directories
  • Optionally: a 30–60 second asciinema or screen recording embedded as a GIF

Help

Comment here if you want to work on this and I will help you get started. First-time contributors are welcome — open a draft PR early and I'll review.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions