Skip to content

docs: simplify the README around a verified starter - #26

Merged
apresmoi merged 2 commits into
mainfrom
docs/readme-product-onboarding
Sep 12, 2026
Merged

apresmoi merged 2 commits into
mainfrom
docs/readme-product-onboarding

Conversation

@apresmoi

@apresmoi apresmoi commented Sep 12, 2026

Copy link
Copy Markdown
Collaborator

The README mixed the initial compile path with deployment, development, publication, and internal lifecycle contracts. Replace that sequence with one verified single-agent starter, then introduce teams through a small valid YAML example and link the deployment and reference guides.

Add a compact ASCII compiler flow, keep the existing artwork, and show only implemented runtime adapters. The entry path explicitly distinguishes compiled configuration from running agents. Only README.md changes.

Validation:

  • Default starter initialized, validated, and compiled from a fresh directory using both current source and npm release 0.1.14. Checked nonempty runtime output, report, and Dockerfile.
  • Team YAML compiled with two uniquely named member projects.
  • CLI build, typechecking, and documentation site build passed.
  • Full final test run passed: 3,508 Vitest tests, 12 node:test cases, and 28 script tests; coverage thresholds passed. The first run hit a Docker image-build timeout; its targeted rerun and the subsequent full run passed.
  • Local and documentation links checked; npm page rejects automated HTTP requests, but registry lookup and package installation succeeded.

Existing issues observed, outside this README change: adding two agents leaves duplicate default manifest names and fails readiness validation; the checked-in Daimon runtime image pin does not attest the current compiler contract. The README leads with the verified OpenClaw starter and does not present either failing path as the quickstart.

The review follow-up states the compiler benefit in the tagline, explains the separate team Spawnfile and init --team, assigns wake schedules to individual agents, and names subscription CLI engines. The added team scaffold command was run in a fresh directory and validated. Independent Fable 5.1 re-review passed.

@apresmoi
apresmoi merged commit 8d082ca into main Sep 12, 2026
1 check passed
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