Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,22 @@
`bdi` is one unblinking eye over every [beads](https://github.com/gastownhall/beads)
tracker you point it at. It draws each tracker's work as a tree, and beside
every bead an agent has claimed, the live [herdr](https://herdr.dev) pane that
agent is sitting in.
agent is sitting in. Select a bead and the tail of its pane is drawn under the
forest, so what the agent is doing is read off the same screen as the work it
is doing it to.

beads knows the work. herdr knows the agents. Neither has heard of the other,
so neither can tell you that `arkham-5` was claimed by a pane that died on
Tuesday. Something old has opened an eye over both, and it can.
Run a few agents through one backlog and this is the view you wanted, and
not one the agents were going to volunteer. beads knows the work. herdr knows
the agents. Neither has heard of the other. Something old has opened an eye
over both.

![A bdi screen: the arkham project over twelve beads in two trees, each bead drawn with its status glyph and its id in that status's colour, three of them with a green agent marker and pane id beside them, one warning that a bead is claimed with no pane behind it, three panes below that no bead claims, and a band at the foot showing what is on the selected bead's pane.](docs/bdi-frame.svg)

The arkham project is made up. `arkham-5` is the Tuesday case: beads says an
agent claimed it, herdr has no pane for that agent, and only something looking
at both can tell you.
Three of arkham's beads have a live agent beside them, and the band at the
foot is what the selected one's pane is saying.
`ark-5` is what else falls out of watching both at once: beads says an agent
claimed it, herdr has no pane for that agent, and the eye says so. It has seen
a pane die on a Tuesday before.

The eye only looks. It never writes to a tracker. Changing the work is still
`bd`'s job, and the eye finds this arrangement acceptable.
Expand Down Expand Up @@ -163,8 +168,8 @@ Hand it over, and let it fold the lines into whatever it already obeys.

## Status

Released, and gazed into daily by the people who wrote it. The design is in
[docs/design.md](docs/design.md).
Released, and gazed into daily by the people who wrote it. It has not yet
gazed back. The design is in [docs/design.md](docs/design.md).

Versions are `0.x`, and a breaking change bumps the minor. Pin a tag. `1.0.0`
arrives when the shape has settled, not when something breaks.
42 changes: 21 additions & 21 deletions docs/bdi-frame.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ key = "metadata.delivery_pr"
render = "⇢ kadath/{}"

[roots.explicit]
arkham = ["arkham-1", "arkham-10"]
arkham = ["ark-1", "ark-10"]

[[badges]]
key = "metadata.delivery_pr"
Expand Down
Loading