WARSHALL
Docs/WorkMap/Nodes and requirements

Nodes and requirements

A node is one feature on the WorkMap. Its card holds the requirements that make up the feature. The panel that opens from the card holds everything the app has recorded about it.

The card

A card shows the feature name, a description and a list of requirements. Its foot has a progress bar, green for shipped and red for blocked, and the totals recorded against the feature, which are tokens, commits and time.

  • Click the description to edit it in place.
  • + requirement adds a requirement and opens it for editing straight away.
  • The header has a button that minimizes the card to a capsule and a trash icon that deletes it.
  • A pending feature has a play control in its header. It runs the feature's first requirement that is not shipped yet, in a terminal bound to the feature.

Each requirement row shows a status dot, its position such as 2.1.3, and its text. Hover the row and the dot turns into a play control, which runs that requirement in a terminal bound to this feature. The x at the end of the row deletes the requirement.

Running a requirement

Pressing play on a requirement sends a prompt to a terminal. The prompt reads Start work on this requirement followed by the requirement text, or Continue the work on this requirement when the requirement was worked before.

  • If a terminal is already bound to the feature, the prompt goes to that terminal.
  • If none is, a new terminal opens on the project, bound to the feature, and the prompt runs there.

The terminal remembers the requirement, so the prompts you type after it are filed under the same requirement, and so are the commits they make. This is how you work on two features at once. Start a requirement on one card, then another on a second card, and each runs in its own terminal.

Editing a requirement

Click a requirement to edit it. A box opens over the row with the requirement text, which you can change, and a small toolbar above it.

ControlWhat it does
StatusSets the status to Mapped, Shipped or Blocked.
PlayRuns the requirement, the same as the play control on the row.
Copy contextCopies the requirement's id to the clipboard.
TickCloses the editor.

Beside the card a small window opens with three fields kept with the requirement. Prompt holds a custom prompt for it. Attachments takes a link or a file name, added with + or Enter. Skills takes skill names separated by commas.

Escape, the tick or a click anywhere else closes the editor.

You pick Mapped, Shipped or Blocked. Deprecated is set by the app when a request undoes work that was done before. A deprecated requirement stays on the map as a record and stops counting toward progress.

The node panel

In the WorkMap window, click a card to open its panel. Click the card itself, such as its title, rather than a button or a requirement on it, since those do their own thing. The panel opens beside the card, on whichever side has room. It moves with the card as you pan and zoom, and scrolls out of view with it.

Escape or a click outside the panel closes it. Dragging the canvas does not. Only one panel is open at a time, and opening the project's conversations closes it.

The head of the panel shows the feature's position, its name, the tokens used on it in and out, and how many files its work changed. Under the head are four tabs, each with a count when it has one.

Conversations

Every prompt run filed under this feature. Each row shows the provider, the opening prompt, the date and the number of turns. Click a row to read the whole conversation, and Conversations at the top takes you back to the list. With nothing recorded the tab reads no conversations recorded for this feature yet. See Conversations.

Attachments

The files that belong to this feature, in two groups.

  • From requirements lists what you added in a requirement's Attachments field, each with the requirement's position.
  • From prompts lists the files that were sent with a prompt, with their path. A context doc is marked FEATURE CONTEXT or PROJECT CONTEXT.

Click a file to open it. Images, PDFs, Markdown, plain text, Word, HTML and LaTeX files open in the app. Anything else opens in the program your computer uses for it. With nothing recorded the tab reads no attachments recorded for this feature.

Summary

A written summary of the feature, made from its requirements and its conversations. Click the text to edit it, and click away or press Escape to save.

  • With no summary yet, the tab reads no summary document yet and offers Generate summary.
  • Under a summary are the day it was made and the model that wrote it. When work has landed since, it adds new work since and offers Regenerate.
  • Before you generate, a card shows the fallback model and the estimated tokens and share of the usage window, so nothing is spent without you seeing it first.

Pull Requests

The reviews you opened on this feature or on its commits, each with its review id and title. Click one to open it in the review window. With none the tab reads no pull requests opened for this feature yet.

From a terminal

The WorkMap mark in a terminal's head shows the position of the feature it is bound to. Press it to open that feature's card in a popup beside the terminal, without opening the WorkMap window. See The WorkMap for the rest of that popup.