-
Notifications
You must be signed in to change notification settings - Fork 1
Pipeline Design 3
The Shipwright README (README.md) documents the autonomous daemon feature but lacks a quick-start guide for new users. The current "Autonomous Daemon" section (approximately lines 363-405) covers the concept but doesn't provide actionable steps to get running quickly. Users need to piece together information from multiple sections to start the daemon, configure it, and monitor it.
This is a documentation-only change — no code is modified. The primary constraint is preserving all existing content and maintaining consistency with the README's existing style (markdown tables, fenced code blocks, command examples with shipwright CLI).
Restructure the existing "Autonomous Daemon" section in README.md into four focused subsections:
-
Quick Start — A numbered 5-step guide covering: generate config (
shipwright daemon init), edit config, start daemon (shipwright daemon start), start detached (--detach), and check status (shipwright daemon metrics). -
Configuration — A markdown table of key daemon config fields (
max_parallel,auto_scale,max_workers,min_workers,poll_interval,self_optimize,auto_template,max_retries,priority_lane) with types, defaults, and descriptions. Reference the existing CLAUDE.md config table for consistency. -
Monitoring — Three essential monitoring commands:
shipwright daemon metrics(DORA dashboard),shipwright status(team dashboard), andshipwright logs <team> --follow(tail logs). -
Auto-Scaling — Explanation of dynamic worker scaling with the four scaling factors (CPU, memory, budget, queue demand), plus a JSON config snippet showing the relevant fields.
This approach follows the existing README pattern of using ### subsections under ## feature sections, markdown tables for configuration, and fenced code blocks for examples.
-
Separate daemon documentation file — Pros: Keeps README concise, allows deeper coverage / Cons: Fragments documentation, users must navigate to a second file for basic setup, inconsistent with how other features (fleet, pipeline) are documented in the README.
-
Add quick-start to top-level "Quick Start" section only — Pros: Users find it immediately / Cons: Separates daemon quick-start from daemon reference content, creates duplication if daemon details remain in their own section.
-
Minimal inline edits (just add a "getting started" paragraph) — Pros: Smallest diff / Cons: Doesn't address the structural gap — users still lack a config reference table and monitoring commands in context.
- Files to create: None
-
Files to modify:
README.md— replace the Autonomous Daemon section (~lines 363-405) with the expanded 4-subsection version - Dependencies: None
-
Risk areas:
- Line numbers may have shifted if other PRs merged — locate the section by heading text (
## Autonomous Daemon) rather than line numbers - Ensure the config field names and defaults match the actual code in
scripts/cct-daemon.shand the daemon config JSON schema - Verify command examples (
shipwright daemon init,shipwright daemon start --detach,shipwright daemon metrics) match current CLI behavior
- Line numbers may have shifted if other PRs merged — locate the section by heading text (
- The
## Autonomous Daemonsection contains four subsections: Quick Start, Configuration, Monitoring, Auto-Scaling - Quick Start has exactly 5 numbered steps with valid
shipwrightcommands - Configuration table fields match those in
.claude/CLAUDE.mddaemon configuration table andscripts/cct-daemon.sh - All three monitoring commands are documented and match actual CLI subcommands
- Auto-Scaling section includes the JSON config snippet with
auto_scale,auto_scale_interval,max_workers,min_workers,worker_mem_gb, andestimated_cost_per_job_usd - No existing content outside the Autonomous Daemon section is modified
- Markdown renders correctly (tables, code blocks, headings)
-
npm testpasses (no test regressions from doc-only change)