Skip to content

docs: the pitch for humans, the when-to-use section, and a fresh screenshot set (issue #175) - #180

Merged
edgehero merged 1 commit into
mainfrom
docs/insights-pitch-and-images
Aug 12, 2026
Merged

docs: the pitch for humans, the when-to-use section, and a fresh screenshot set (issue #175)#180
edgehero merged 1 commit into
mainfrom
docs/insights-pitch-and-images

Conversation

@edgehero

Copy link
Copy Markdown
Owner

The last slice of #175: both READMEs now open with what pi-dispatch is, why, and when to use it, written for a reader who has never run a coding agent, and the screenshot set catches up with the shipped surface.

What

  • Root README: the lead answers the context-free reader (an agent working on your repos while nobody watches, no surprise bills, no keys to the machine). A new When to use it section gives four concrete recurring-loop scenarios and names the one case plain pi already covers (a one off interactive session). A design/observe/tune paragraph frames triggers plus skills, the graph, and insights as one loop-engineering cycle, links the three docs, and shows the insights page. The admin-panel and graph sections gain the new facts (four cost tables, schedule and spend on trigger rows, /dispatch insights html), and the plain-commands list finally names graph and insights.
  • admin/README (what npm renders): the same lead promise, updated costs/graph bullets, and a new one-page-for-both-questions bullet with the insights screenshot.
  • Images: costs-view.svg footer now says [f] table and its PNG is re-rendered at the exact prior dimensions (1803x1097); graph-view.png regenerated from a demo model so it shows the observed-edge recency and the honesty counters (2480x1600, the prior dimensions); NEW docs/images/insights-view.png from a populated insights.html. Changed images bump to ?v=0.11.0.

Both READMEs keep the no-dash-punctuation rule. Specs UNCHANGED, checked: this slice states what the earlier slices shipped and changes no behaviour. Suite green in the CI posture (2224 tests, 0 skipped, live Valkey).

…enshot set (issue #175)

The last insights slice: both READMEs now open with what this is, why,
and when to use it, for a reader who has never run an agent, and the
images catch up with the shipped surface.

- Root README: the lead paragraph answers the context-free reader (an
  agent working while nobody watches, no surprise bills, no keys to
  the machine); a new 'When to use it' section gives four concrete
  recurring-loop scenarios and names the one case plain pi already
  covers; a design/observe/tune paragraph frames triggers+skills, the
  graph, and insights as one loop-engineering cycle and links the
  three docs; the insights page gets its screenshot in that section.
  The panel and graph sections gain the new facts (four cost tables,
  schedule and spend on trigger rows, /dispatch insights html), and
  the plain-commands list finally names graph and insights.
- admin/README (the npm-facing console page): same lead promise, the
  costs/graph bullets updated, a new one-page-for-both-questions
  bullet with the insights screenshot.
- Images: costs-view.svg footer says [f] table and the PNG is
  re-rendered at its exact prior dimensions (1803x1097, scale
  2.68303571); graph-view.png regenerated from a demo model so it
  shows the observed edge recency and the honesty counters (2480x1600,
  the prior dimensions); NEW insights-view.png from a populated
  insights.html. Changed images bump to ?v=0.11.0.

Both READMEs keep the no-dash-punctuation rule. Specs UNCHANGED,
checked: this slice states what earlier slices shipped and changes no
behaviour.

Suite green in the CI posture: 2224 tests, 0 skipped, live Valkey.

Signed-off-by: Rob Boerman <robboerman@live.nl>
@edgehero
edgehero merged commit 1762867 into main Aug 12, 2026
12 checks passed
edgehero added a commit that referenced this pull request Aug 12, 2026
Ships the insights consolidation: issues #175 and #181, PRs #176-#180
and #182-#184.

- admin 0.8.0: insights is the ONE analytics surface. Bare /dispatch
  insights (and the panel's i key) writes and opens the self-contained
  page: budget dials with used-vs-cap facts and the worker's own
  states, plan verdicts, daily + cumulative + per-flow spend charts,
  the four breakdowns, and the trigger/flow topology with schedule
  tips and spend badges. insights whatif is the estimator. The COSTS
  and GRAPH views and the costs/graph subcommands are REMOVED; the
  cost-fold correctness fixes (requested-window proration, flowKey,
  other/other, truncated-ledger counter) and the byTrigger/byRepo/
  dailyByFlow folds ride along. dispatch_costs is unchanged.
- worker 0.3.0 and receiver 0.2.1 are unchanged since v0.10.0 and
  their publishes skip.
- Image ?v= tags normalized to this release's version.

Suite green in the CI posture: 2192 tests, 0 skipped, live Valkey.

Signed-off-by: Rob Boerman <robboerman@live.nl>
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