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
1 change: 1 addition & 0 deletions Docs/DESIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ folder where a subject needs several. A file here is binding, not background.
| [design/services/create-and-merge.md](design/services/create-and-merge.md) | Create Pull Request and its push, merging from the page, the merge form, Merge When Ready, Cancel Auto-Merge. |
| [design/services/marks-and-pages.md](design/services/marks-and-pages.md) | Row marks and colours, the panel's pull request and CI pages, checks, merge verdicts, failed run reports. |
| [design/services/merge-path.md](design/services/merge-path.md) | The pull request page's steps toward a merge, their order, the checks under one step, hints, the merge at the end, settled pull requests, its text colour. |
| [design/services/send-feedback.md](design/services/send-feedback.md) | Sending failing checks, review threads and failed CI jobs from the PR and CI pages: the shared Send foot and its `Handoff*` names, checkboxes and the step's mixed one, the sent bubble, item keys, what Send writes, log reads at Send, the thread read, Run output. |
| [design/services/debug-stand-in.md](design/services/debug-stand-in.md) | Debug services stand-in, its JSON, how it waits on reads. |
| [design/files/panel.md](design/files/panel.md) | The Files panel's place, what it lists, ignored files and their pace, the index read, caps, the pages and their saved choice, the filter, its switch and width, fitting columns, the badge's click, Copy Path, background reads, listing rebuilds, submodules, PR and CI pages. |
| [design/files/file-tabs.md](design/files/file-tabs.md) | The open rule, file tabs as their own type in one order, saved tabs and their scroll, deleted and renamed files, the diff against HEAD and staged marks, re-reads and their pace, hidden tabs, the 1 MiB cap, encodings, TextKit 2 rows, fonts, tints and word diffs, the gutter, copy, find, the Changes rotor, Split, the bar, change arrows and the boxed change. |
Expand Down
12 changes: 10 additions & 2 deletions Docs/design/agents/command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,9 @@ The command line's requests on the reports' socket. Newest at the bottom.
stops the pre-create hook or git as the sheet's Cancel does. The helper shuts
its writing half after the request, so EOF says nothing; the reply polls for
POLLHUP, which macOS sets only once both halves are shut, every 250 ms until
it is sent. A cancelled task stops nothing else: nothing else a request awaits
checks for it.
it is sent. `pr send` checks once its reads end, so a Ctrl-C while its logs
read pastes nothing into the agent. A cancelled task stops nothing else: the
reads themselves run on, and nothing else a request awaits checks for it.
- **The app answers in data and the helper words it** (translation.md): ids and
JSON on success, a typed refusal otherwise.
- **Whatever a command prints is JSON**, indented and sorted as the app's
Expand Down Expand Up @@ -232,6 +233,13 @@ The command line's requests on the reports' socket. Newest at the bottom.
- **`tabs open-all-changes` opens or turns to a worktree's All changes tab**,
and `tabs list` reports it as kind `all-changes`; `tabs step` and `tabs find`
reach it as a file tab (files/all-changes-tab.md).
- **`pr send` and `ci send` take `--worktree` as `review` does** and send the
page's checked items without taking the keyboard, as `review send` does.
`--checks` or `--threads` sends that kind alone. With nothing checked and
unsent they are refused; `ci send` is told to show the page, which reads its
run's jobs only while shown, where `pr send` reads checks and threads itself
off the PR page (services/send-feedback.md). `pr send` waits with no timeout,
its answer coming once every checked check's log is read.

## Reviewed and left as is

Expand Down
3 changes: 3 additions & 0 deletions Docs/design/files/review-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,9 @@ panel's Review page (issue #6). Newest at the bottom.
per file against that file's rows. The composer carries its file's path, the
All changes tab holding several, and the tables a composer and its draft live
in are keyed by the tab hosting cards, a file or All changes tab.
- **Review's foot and picker are shared with the PR and CI pages**, renamed
`Handoff*` in `Files/Panel/Handoff/` with one pick per worktree; see
[services/send-feedback.md](../services/send-feedback.md).

## Reviewed and left as is

Expand Down
14 changes: 9 additions & 5 deletions Docs/design/services/debug-stand-in.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ service's own command-line tool, for a scripted run.
`title`, `state`, `headBranch`, `headCommit` and `headRepository` (a remote
URL or `owner/name`), and optionally `url` (its GitHub page by default),
`review`, `blocker`, `isReadyToMerge`, `autoMergesWhenReady`, `baseBranch`,
`updatedAt` and `checks` (`name`, `status`, `workflow`, `isRequired`, `link`);
and `ciRuns`, each with `id`, `branch`, `commit` and `status`, and optionally
`subject`, `isFinished`, `createdAt`, `repository` (where it ran; none matches
every project), `workflows` (`name`, `status`, `jobs` of `id`, `name`,
`status`) and `failures` (`workflow`, `job`, `text`). Dates are ISO 8601.
`updatedAt`, `checks` (`name`, `status`, `workflow`, `isRequired`, `link`,
`log`, the text a failed log read answers) and `threads` (`id`, `path`,
`line`, `originalLine`, `isOutdated`, `diffHunk`, `comments` of `id`,
`author`, `body`, `url`), a thread with no comments refused as the host never
answers one; and `ciRuns`, each with `id`, `branch`, `commit` and `status`,
and optionally `subject`, `isFinished`, `createdAt`, `repository` (where it
ran; none matches every project), `workflows` (`name`, `status`, `jobs` of
`id`, `name`, `status`) and `failures` (`workflow`, `job`, `text`). Dates are
ISO 8601.
- **A value the stand-in cannot read refuses all of it**, a key no record takes
or one missing included, naming the key path, rather than dropping one run
unseen. The helper reads the file and sends its text, so the app opens no path
Expand Down
3 changes: 3 additions & 0 deletions Docs/design/services/marks-and-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@ panel's pages.
hold at most once a minute however often its list appears, one read at a time
per run, and once more as it ends, a run reading failed while jobs still went;
an earlier run's when its row opens.
- **The PR page also reads its open pull request's unresolved review threads**,
beside the checks and at their pace, kept for the panel's worktree alone. Both
pages send what failed to an agent; see [send-feedback.md](send-feedback.md).

## Reviewed and left as is

Expand Down
3 changes: 3 additions & 0 deletions Docs/design/services/merge-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ or more checks the failing one sat among the passing ones.
- **The words are the theme's text colour, not its secondary grey**: at 11 pt
the grey measured 4.0:1 on the panel in Multishell Light. The chevron and the
card keep their greys.
- **Unresolved review threads list under the review step**, or a Comments step
of their own where there is none, which is not counted among the steps left: a
thread holds no merge back. See [send-feedback.md](send-feedback.md).

## Reviewed and left as is

Expand Down
Loading
Loading