Skip to content

README: document evals directly, not just a link #146

Description

@renaudcepre

Evals are apte's main differentiator but the README mostly points to the docs
site. A reader skimming the README should understand the eval model without
leaving the page.

Add directly in the README:

  • What an eval is in apte terms: a test that returns a value, scored not
    asserted (the one-liner exists; expand it with a minimal but complete example).
  • The scoring/evaluators model: built-in evaluators, custom evaluators,
    LLM-as-judge, what a score looks like.
  • The history/runs story: apte eval, .apte/history.jsonl, how trends are
    tracked across runs.
  • When to reach for evals vs tests.

Keep the deep reference on the docs site, but the README should stand on its
own for the eval pitch.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions