Skip to content

docs: README + SPEC sweep #30

@alokwhitewolf

Description

@alokwhitewolf

Several rounds of features have landed without a docs sweep. Audit:

  • README.md
  • SPEC.md
  • plugins/evo/README.md
  • sdk/python/README.md
  • sdk/node/README.md

Things to fix:

  • Score channel is $EVO_RESULT_PATH -- a file written by the helper/SDK, falls back to stdout when unset. Anything saying "print JSON to stdout" is wrong (Score parsing and user logs share the same channel (stdout) #9).
  • Gates run with EVO_* stripped from env so SDK-using gates can't overwrite result.json or task traces. Doc the gate contract accordingly.
  • evo init --backend <worktree|pool> plus --workspaces /a,/b,/c. New evo workspace status / release subcommands. Pool mode contract (lease lifecycle, gitignored warm state) belongs in SPEC.md.
  • evo dispatch uses lineage forking -- children of committed experiments fork the parent's session rather than a fresh explorer. Existing dispatch prose likely says explorer-only.

Audit against evo --help / evo init --help / evo dispatch --help / evo workspace --help. Replace contradictions.

Skills (plugins/evo/skills/discover/SKILL.md, plugins/evo/skills/optimize/SKILL.md) are current; out of scope.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions