Skip to content

[Feature] One harness evolution tutorial with two chapters, from reports and from requests #462

Closed

Description

@Benjamin-eecs

Primary area

Documentation

Problem

tutorials/evolve-your-harness/ and tutorials/harness-requests/ are the same mechanism with two triggers, and the names do not say so. The second folder has no method code: its configs/deployment.yaml points at the first folder's harness.evolution:* (now reef.recipe.reefine), and the rest is a demo driver and its records. A reader takes them for two features.

Concrete use cases

A person who finished the first tutorial opens the second and reads the loop again from the top; a person who wants "ask for a change" does not find it under a folder named after the mechanism.

Proposed outcome

One folder, tutorials/evolve-your-harness/, with two chapters named by where the change comes from:

  • from reports: the served traffic's scores drive the step (today's max_score: 0.0, failures; successes by setting min_score).
  • from requests: a person's words drive the step (reef-pi harness "...", /reef-harness ...).

configs/from-reports.yaml and configs/from-requests.yaml; harness-requests/demos/ and its run records move under the one folder; tutorials/README.md lists one tutorial with two entry points. harness-requests/ goes away.

Alternatives and workarounds

Keep two folders and name them by the trigger. Rejected in chat: the names get long and the loop is still explained twice.

Compatibility and maintenance

About 30 inbound references: the README pair (re-pin README.i18n.yaml), docs pages, CODEOWNERS, labeler, and the tests that hold the paths. One PR.

Platforms

Docs and configs only.

Submission checks

  • I searched existing issues and did not find the same request.
  • I removed credentials, tokens, private data, and other secrets from this request.

Activity

  1. added
    enhancementNew capability or improvement to existing behavior
    status: needs-triageNeeds an initial maintainer decision and routing
    on Sep 14, 2026
  2. Benjamin-eecs commented on Sep 17, 2026

    @Benjamin-eecs
    MemberAuthor

    Landed in another shape with #468: tutorials/harness-requests is gone, the request driven path is the Reefine tutorial under tutorials/reefine, and tutorials/evolve-your-harness keeps the report driven path. The loop is no longer explained twice under two folders of the same mechanism.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsUser and developer documentationenhancementNew capability or improvement to existing behaviorstatus: needs-triageNeeds an initial maintainer decision and routing

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions