From 2696044a02f76e9ccba1b6a877613c9092e90716 Mon Sep 17 00:00:00 2001 From: Danijel Simeunovic Date: Sat, 1 Aug 2026 12:07:26 +0200 Subject: [PATCH] docs --- docs/agents/domain.md | 36 ++++++++++++++++++++++++++++++++++++ docs/agents/issue-tracker.md | 27 +++++++++++++++++++++++++++ docs/agents/triage-labels.md | 15 +++++++++++++++ 3 files changed, 78 insertions(+) create mode 100644 docs/agents/domain.md create mode 100644 docs/agents/issue-tracker.md create mode 100644 docs/agents/triage-labels.md diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 0000000..fbaef2a --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,36 @@ +# 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/ +``` + +## 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 new file mode 100644 index 0000000..fe016af --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,27 @@ +# Issue tracker: Gitea + +Issues for this repo live in Gitea at `git.forteapps.net/Forte/launchpad`. Use the Gitea API or `tea` CLI. + +## Conventions + +- **Create an issue**: `tea issue create --title "..." --description "..."` + or via API: `curl -X POST "https://git.forteapps.net/api/v1/repos/Forte/launchpad/issues" -H "Authorization: token $GITEA_TOKEN" -H "Content-Type: application/json" -d '{"title":"...","body":"..."}'` +- **Read an issue**: `tea issue view ` or API `GET /api/v1/repos/Forte/launchpad/issues/` +- **List issues**: `tea issue list` or API `GET /api/v1/repos/Forte/launchpad/issues?state=open` +- **Comment on an issue**: `tea issue comment "..."` or API `POST /api/v1/repos/Forte/launchpad/issues//comments` +- **Apply labels**: API `POST /api/v1/repos/Forte/launchpad/issues//labels` with `{"labels": []}` +- **Close**: API `PATCH /api/v1/repos/Forte/launchpad/issues/` with `{"state": "closed"}` + +Infer the repo from `git remote -v`. + +## Pull requests as a triage surface + +**PRs as a request surface: no.** + +## When a skill says "publish to the issue tracker" + +Create a Gitea issue. + +## When a skill says "fetch the relevant ticket" + +Fetch the issue via API or `tea issue view `. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md new file mode 100644 index 0000000..b716855 --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,15 @@ +# 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.