Skip to content

Add a new reference trace #2

Description

@JieGroup

Flowtrace ships its examples as one-command builders under scripts/examples/<id>/. Each builder constructs a real trace folder under ~/traces/<id>/ (with its own .git) and walks the CLI lifecycle once to leave a demo run behind.

Add a new reference trace for a broadly useful, relatable task — for example:

  • changelog-from-commits — turn a git log into a grouped, human-readable changelog
  • recipe-from-pantry — ingredients in, a cooking plan out
  • meeting-notes — transcript in, decisions + action items out

Where to look

  • Copy the shape of an existing builder, e.g. scripts/examples/nested-deps/ (a clean diamond DAG) and the shared helpers in scripts/examples/_lib.sh.
  • The DAG + step contracts follow docs/trace/SCHEMA.md; see docs/trace/REFERENCE-TRACES.md for what each builder demonstrates.

Done when

  • bash scripts/examples/<id>/build.sh creates ~/traces/<id>/ and it renders in flowtrace serve.
  • The new example is listed in docs/EXAMPLES.md.

Good first issue — self-contained, follows an existing pattern. Comment to claim it before you start.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Fields

    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