Skip to content

The operator guide has no home in this repository #7

Description

@josemontesdeoca

The README's Operator guide section is a pointer, not a document. The install → reactor.ymlcompile → run → serve lifecycle and the keyless reactor-devtools replay are written down in skills/open-prose/reactor.md — a file this repository has decided it will not edit.

skills/README.md is explicit about that: the snapshot is pinned at skill 0.15.0 "on purpose", bumped only as a reviewed change with the harness re-run against it, and "do not edit files under skills/open-prose/ directly — skill changes belong in openprose/prose."

Two consequences:

  • The guide ages with the snapshot, not with the CLI. Anything that changes in reactor-cli after skill 0.15.0 has nowhere to be documented. Editing the pinned copy in place would defeat the reason it is pinned.
  • It is now the only copy, and it describes a surface that no longer exists upstream. Skill 0.16.0 removed prose react and reactor.md from the skill (runtime_contract unchanged at 2), so the guide's framing — a prose react playbook the skill routes into — is history. Read today it teaches a flow the language no longer has.

Options

  1. Fork it into a repository-owned docs/operator-guide.md, drop the prose react framing, keep the lifecycle and the replay walkthrough, and retarget the README. The snapshot keeps its frozen copy, untouched.
  2. Fold it into packages/reactor-cli/README.md, which is already the per-command reference and the telemetry policy's home, so the README points at one place instead of two.
  3. Leave it, and accept that the operator guide is frozen at 0.15.0 and drifts.

(1) or (2). The guide is the only prose that describes the lifecycle end to end, and right now the repository does not own it.

Activity

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

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions