Skip to content

docs: refresh README and repository metadata - #6

Merged
nothingnesses merged 3 commits into
mainfrom
docs/refresh-readme-metadata
Sep 2, 2026
Merged

docs: refresh README and repository metadata#6
nothingnesses merged 3 commits into
mainfrom
docs/refresh-readme-metadata

Conversation

@nothingnesses

Copy link
Copy Markdown
Owner

Summary

  • Update repository URLs, badges, clone instructions, package metadata, and rename-history pointers.
  • Describe the bounded default workflow and its logical role contracts.
  • State that the harness or an external runner supplies execution isolation.
  • Match the GitHub repository description to the reviewed package description.

Verification

  • just ci passed at b476a1ceb96eaf2a0d6ba5edc7b78f1a94c9a084.
  • The independent review raised one low finding based on a misread description boundary.
  • Separate triage reproduced the exact proposed description and dismissed the finding.
  • The GitHub description now matches Cargo.toml exactly.

The README badge link, clone commands, and issue route pointed at the
former nothingnesses/agent-scaffold path, and the Cargo `repository`
field did too. Point all of them at nothingnesses/agent-flow, and let
the package description name the bounded workflow the default
scaffolds.

Remove the temporary "The `agent-flow` rename" README section. The
0.0.3 changelog entry is the durable record of the rename and of the
upgrade steps, so the installation section points there instead. The
released 0.0.2 and 0.0.3 entries name the removed section as
authoritative, and both stay exactly as published, so a new Unreleased
entry carries the current statement and the contact route in their
place.

State in the README that the scaffolded roles are contracts rather
than isolation: the tool writes the role prompts and the work state
and projects them, launches no agent, spawns no process, creates no
worktree for a role, and enforces no separation of processes,
filesystems, networks, credentials, or tools between roles. The
harness or external runner supplies that isolation, and the
independence of a product review with it.
@nothingnesses
nothingnesses merged commit cf70fd1 into main Sep 2, 2026
1 check passed
@nothingnesses
nothingnesses deleted the docs/refresh-readme-metadata branch September 2, 2026 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant