Skip to content

docs(ui): document the working-status registry item (FIX-2527) - #4815

Draft
jhoffner wants to merge 2 commits into
mainfrom
docs/FIX-2527-working-status
Draft

jhoffner wants to merge 2 commits into
mainfrom
docs/FIX-2527-working-status

Conversation

@jhoffner

@jhoffner jhoffner commented Nov 5, 2026

Copy link
Copy Markdown
Collaborator

The problem

The UI registry's working-status item (merged in #4782) has no user docs. Someone building a feed for a background task or a coding agent run can't find how to give it a live "what it's doing now" line. The docs were held out of #4782 under the release-docs rule.

What this does

  • apps/docs/docs/ui/common-components.md: a new "What a running task is doing now" section under Streaming Indicator. It covers toolInFlight and workingStatus, what each workingStatus field takes, the order of preference (call in flight, plan step, progress note, then "Working..."), how each case reads, and an example with StreamingIndicator.
  • packages/ui/README.md: a working-status row in the component table.

Compared with the text held out of #4782, it adds two things that shipping showed matter:

  • pass toolInFlight only the items of the request the task is running now;
  • show the line only while the task is running and not waiting on someone.

What's asked of you

Nothing here is yours to decide. Read the new section the way a new user would.

Parts worth reviewing closely

  • The inFlight bullet. It tells the reader to pass only the current request's items, because a reused session can still hold a call from an earlier request that never finished.

Linear: FIX-2527 · follows #4782 · draft, merges when approved (docs-fix label: user docs for a registry item already on main)

Everything else
  • GITHUB_HEAD_REF=docs/FIX-2527-working-status node scripts/validate-user-docs-scope.mjs exits 1 on this branch without the label and names both files. The docs-fix label is the documented exception (docs/contributing/release-docs.md, "In a normal PR").
  • No changeset: docs only.
  • Prose self-check against docs/contributing/user-docs.md (outsider rule and tells table): no diff, defect or design narrative, no counted preambles, no em-dashes, no issue ids in the page. A docs-editor pass was not run; the coordinator can dispatch one.
  • Every link target was checked: /docs/tools/coding-agents, its #the-runs-plan anchor, and this page's #tool heading.

Generated by Claude Code

The common-components page gains a section on the live last line of a
running task's feed: `toolInFlight` and `workingStatus`, paired with
`StreamingIndicator`. The ui README lists the item. Both were held out of
the feature PR under the release-docs rule; this is the docs-fix follow-up.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DME8pzA4e4Rc7fRLGsYavW
@vercel

vercel Bot commented Nov 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
flow-state-dev-docs Canceled Canceled Nov 5, 2026 10:17pm UTC
2 Skipped Deployments
Project Deployment Actions Updated
flow-state-dev-ui Ignored Ignored Preview Nov 5, 2026 10:17pm UTC
flow-state-dev-build-site Skipped Skipped Nov 5, 2026 10:17pm UTC

Request Review

@jhoffner jhoffner added the docs-fix label Nov 5, 2026 — with Claude
@linear-code

linear-code Bot commented Nov 5, 2026

Copy link
Copy Markdown

FIX-2527

State the in-progress rule as working-status.ts applies it, show the
running-and-not-waiting condition in the example, drop the counted preamble,
and write the timer the way StreamingIndicator renders it, in parentheses.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DME8pzA4e4Rc7fRLGsYavW

This branch was successfully deployed

1 active deployment
Preview – flow-state-dev-docs — 778b823f Deployed Nov 5, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant