From 0caca3c6b95035f221946c6eab9cef26dd0667a5 Mon Sep 17 00:00:00 2001 From: softmaxe <94467584+softmaxe@users.noreply.github.com> Date: Thu, 29 Oct 2026 19:58:17 +0800 Subject: [PATCH] docs: remove Matt Pocock skill setup artifacts Remove the setup-generated agent configuration and domain glossary now that the workflow is no longer used. --- AGENTS.md | 14 ---------- CONTEXT.md | 45 ------------------------------- docs/agents/domain.md | 51 ------------------------------------ docs/agents/issue-tracker.md | 45 ------------------------------- docs/agents/triage-labels.md | 15 ----------- 5 files changed, 170 deletions(-) delete mode 100644 CONTEXT.md delete mode 100644 docs/agents/domain.md delete mode 100644 docs/agents/issue-tracker.md delete mode 100644 docs/agents/triage-labels.md diff --git a/AGENTS.md b/AGENTS.md index 43f6f78..64c5d1e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,17 +1,3 @@ -## Agent skills - -### Issue tracker - -Issues live in GitHub Issues for `softmaxe/gbat`, managed with the `gh` CLI. See `docs/agents/issue-tracker.md`. - -### Triage labels - -Uses the five default labels: `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`. See `docs/agents/triage-labels.md`. - -### Domain docs - -Single-context: one root `CONTEXT.md` plus `docs/adr/`. See `docs/agents/domain.md`. - ## Versioning "Bump the version" means a patch bump unless a specific version is given: increment the last component of `version` in `Cargo.toml` (`X.Y.Z` → `X.Y.Z+1`, e.g. `0.0.1` → `0.0.2`, `0.0.9` → `0.0.10`). Then run `cargo update --workspace` so `Cargo.lock` records the new version, and commit both files; CI builds with `--locked` and fails on a stale lockfile. diff --git a/CONTEXT.md b/CONTEXT.md deleted file mode 100644 index 341b060..0000000 --- a/CONTEXT.md +++ /dev/null @@ -1,45 +0,0 @@ -# gbat - -A one-shot macOS CLI that reads the battery status of a Logitech G Pro Wireless 2 over HID++ and prints one line. - -## Language - -### Devices - -**Receiver**: -The LIGHTSPEED USB dongle that relays HID++ traffic to the wireless mouse over its pairing slots. -_Avoid_: Dongle, adapter - -**HID interface**: -One Logitech interface on the HID++ usage page that macOS enumerates; a receiver or a USB-connected mouse can expose several, and gbat probes each one at every device index. -_Avoid_: Interface (alone), HID device, transport - -**Device index**: -The HID++ address of a device: a receiver pairing slot (1–6), or 0xFF for a mouse connected directly over USB. -_Avoid_: Slot number, device ID - -**Offline**: -The state of a mouse that is paired to the receiver but not currently connected to it, because it is switched off or in deep sleep; the receiver answers requests for its device index with an unknown-device error, and only moving the mouse brings it back. -_Avoid_: Unresponsive, disconnected, missing, asleep - -**Idle**: -The state of a connected mouse whose radio is in power saving after a short rest; it still answers, but only after waking, so the first read is a cold read. A mouse left idle long enough goes offline. -_Avoid_: Asleep, sleeping - -**Cold read**: -A read that has to wake an idle mouse first, and so is slower than a normal read. -_Avoid_: First read, slow read - -### Speed and cost - -**Read latency**: -Time from invoking gbat to the battery status line on stdout, while the mouse is reachable. -_Avoid_: Reaction speed, response speed, responsiveness - -**Failure latency**: -Time from invoking gbat to it giving up with an error, when the mouse is asleep, disconnected, or otherwise unreachable. -_Avoid_: Timeout (that names a mechanism, not the user-visible wait) - -**Footprint**: -The resources one invocation costs: binary size, CPU time, and peak memory. -_Avoid_: Performance (too broad; say which of the three terms you mean) diff --git a/docs/agents/domain.md b/docs/agents/domain.md deleted file mode 100644 index 3524904..0000000 --- a/docs/agents/domain.md +++ /dev/null @@ -1,51 +0,0 @@ -# Domain Docs - -How the engineering skills should consume this repo's domain documentation when exploring the codebase. - -## Before exploring, read these - -- **`CONTEXT.md`** at the repo root, or -- **`CONTEXT-MAP.md`** at the repo root if it exists: it points at one `CONTEXT.md` per context. Read each one relevant to the topic. -- **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src//docs/adr/` for context-scoped decisions. - -If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved. - -## File structure - -Single-context repo (most repos): - -``` -/ -├── CONTEXT.md -├── docs/adr/ -│ ├── 0001-event-sourced-orders.md -│ └── 0002-postgres-for-write-model.md -└── src/ -``` - -Multi-context repo (presence of `CONTEXT-MAP.md` at the root): - -``` -/ -├── CONTEXT-MAP.md -├── docs/adr/ ← system-wide decisions -└── src/ - ├── ordering/ - │ ├── CONTEXT.md - │ └── docs/adr/ ← context-specific decisions - └── billing/ - ├── CONTEXT.md - └── docs/adr/ -``` - -## Use the glossary's vocabulary - -When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids. - -If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`). - -## Flag ADR conflicts - -If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: - -> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_ diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md deleted file mode 100644 index b258aeb..0000000 --- a/docs/agents/issue-tracker.md +++ /dev/null @@ -1,45 +0,0 @@ -# Issue tracker: GitHub - -Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations. - -## Conventions - -- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. -- **Read an issue**: `gh issue view --comments`, filtering comments by `jq` and also fetching labels. -- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters. -- **Comment on an issue**: `gh issue comment --body "..."` -- **Apply / remove labels**: `gh issue edit --add-label "..."` / `--remove-label "..."` -- **Close**: `gh issue close --comment "..."` - -Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone. - -## Pull requests as a triage surface - -**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_ - -When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents: - -- **Read a PR**: `gh pr view --comments` and `gh pr diff ` for the diff. -- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`). -- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`. - -GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`. - -## When a skill says "publish to the issue tracker" - -Create a GitHub issue. - -## When a skill says "fetch the relevant ticket" - -Run `gh issue view --comments`. - -## Wayfinding operations - -Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets. - -- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`. -- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #` at the top of the child body. Labels: `wayfinder:` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev. -- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos///issues//dependencies/blocked_by -F issue_id=`, where `` is the blocker's numeric **database id** (`gh api repos///issues/ --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #, #` line at the top of the child body. A ticket is unblocked when every blocker is closed. -- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins. -- **Claim**: `gh issue edit --add-assignee @me`, the session's first write. -- **Resolve**: `gh issue comment --body ""`, then `gh issue close `, then append a context pointer (gist + link) to the map's Decisions-so-far. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md deleted file mode 100644 index b716855..0000000 --- a/docs/agents/triage-labels.md +++ /dev/null @@ -1,15 +0,0 @@ -# Triage Labels - -The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker. - -| Label in mattpocock/skills | Label in our tracker | Meaning | -| -------------------------- | -------------------- | ---------------------------------------- | -| `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue | -| `needs-info` | `needs-info` | Waiting on reporter for more information | -| `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent | -| `ready-for-human` | `ready-for-human` | Requires human implementation | -| `wontfix` | `wontfix` | Will not be actioned | - -When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table. - -Edit the right-hand column to match whatever vocabulary you actually use.