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
13 changes: 7 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,19 @@ jobs:
id: plutobook-cache
with:
path: tmp/plutobook-ci-install
key: plutobook-v0.17.0-${{ runner.os }}-${{ hashFiles('.github/workflows/ci.yml') }}
key: plutobook-v0.18.0-${{ runner.os }}-${{ hashFiles('.github/workflows/ci.yml') }}
restore-keys: |
plutobook-v0.17.0-${{ runner.os }}-
plutobook-v0.18.0-${{ runner.os }}-

- name: Build PlutoBook
if: steps.plutobook-cache.outputs.cache-hit != 'true'
run: |
git clone --depth 1 --branch v0.17.0 https://github.com/plutoprint/plutobook.git tmp/plutobook-ci-src
git clone --depth 1 --branch v0.18.0 https://github.com/plutoprint/plutobook.git tmp/plutobook-ci-src
meson setup tmp/plutobook-ci-build tmp/plutobook-ci-src \
--prefix="$PWD/tmp/plutobook-ci-install" \
--libdir=lib \
--buildtype=release \
-Dcpp_args="['-include', 'memory_resource']" \
--force-fallback-for=harfbuzz \
-Dcurl=disabled \
-Dturbojpeg=disabled \
Expand Down Expand Up @@ -129,14 +130,14 @@ jobs:
id: plutobook-cache-macos
with:
path: tmp/plutobook-ci-install
key: plutobook-v0.17.0-${{ runner.os }}-${{ hashFiles('.github/workflows/ci.yml') }}
key: plutobook-v0.18.0-${{ runner.os }}-${{ hashFiles('.github/workflows/ci.yml') }}
restore-keys: |
plutobook-v0.17.0-${{ runner.os }}-
plutobook-v0.18.0-${{ runner.os }}-

- name: Build PlutoBook
if: steps.plutobook-cache-macos.outputs.cache-hit != 'true'
run: |
git clone --depth 1 --branch v0.17.0 https://github.com/plutoprint/plutobook.git tmp/plutobook-ci-src
git clone --depth 1 --branch v0.18.0 https://github.com/plutoprint/plutobook.git tmp/plutobook-ci-src
meson setup tmp/plutobook-ci-build tmp/plutobook-ci-src \
--prefix="$PWD/tmp/plutobook-ci-install" \
--libdir=lib \
Expand Down
15 changes: 15 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,18 @@ bundle exec rake
```

If the environment lacks `plutobook`, report that compilation or tests could not be completed and include the relevant error.

## Agent skills

### Issue tracker

Issues live in GitHub Issues for dixpac/page_print. See `docs/agents/issue-tracker.md`.

### Triage labels

Default triage roles: needs-triage, needs-info, ready-for-agent, ready-for-human, wontfix. See `docs/agents/triage-labels.md`.

### Domain docs

Single-context: root CONTEXT.md + docs/adr/. See `docs/agents/domain.md`.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ Build an Apple Silicon macOS platform gem with a vendored PlutoBook library:
bundle exec rake package:darwin_arm64
```

These tasks check out PlutoBook `v0.17.0`, build it into `lib/page_print/vendor/<platform>`, and write a platform gem to `pkg/`. Platform gems compile the Ruby extension during gem install to avoid tying the gem to the build machine's Ruby version.
These tasks check out PlutoBook `v0.18.0`, build it into `lib/page_print/vendor/<platform>`, and write a platform gem to `pkg/`. Platform gems compile the Ruby extension during gem install to avoid tying the gem to the build machine's Ruby version.

Native gems bundle PlutoBook and its non-system shared library dependencies. Optional PlutoBook features for curl, TurboJPEG, and WebP are disabled to keep the bundled dependency set smaller.

Expand Down
51 changes: 51 additions & 0 deletions docs/agents/domain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# 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/<context>/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…_
45 changes: 45 additions & 0 deletions docs/agents/issue-tracker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Issue tracker: GitHub

Issues and PRDs 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 <number> --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 <number> --body "..."`
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
- **Close**: `gh issue close <number> --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 <number> --comments` and `gh pr diff <number>` 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 <number> --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 #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`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/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --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: #<n>, #<n>` 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 <n> --add-assignee @me` — the session's first write.
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
15 changes: 15 additions & 0 deletions docs/agents/triage-labels.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion rakelib/package_darwin.rake
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ require "bundler"
require "rbconfig"
require "shellwords"

PAGE_PRINT_PLUTOBOOK_VERSION = "v0.17.0" unless defined?(PAGE_PRINT_PLUTOBOOK_VERSION)
PAGE_PRINT_PLUTOBOOK_VERSION = "v0.18.0" unless defined?(PAGE_PRINT_PLUTOBOOK_VERSION)
PAGE_PRINT_DARWIN_PLATFORM = "arm64-darwin"
PAGE_PRINT_DARWIN_SYSTEM_PREFIXES = [
"/System/Library/",
Expand Down
4 changes: 2 additions & 2 deletions rakelib/package_linux.rake
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ require "rbconfig"
require "rubygems/package_task"
require "shellwords"

PAGE_PRINT_PLUTOBOOK_VERSION = "v0.17.0" unless defined?(PAGE_PRINT_PLUTOBOOK_VERSION)
PAGE_PRINT_PLUTOBOOK_VERSION = "v0.18.0" unless defined?(PAGE_PRINT_PLUTOBOOK_VERSION)
PAGE_PRINT_LINUX_PLATFORM = "x86_64-linux"
PAGE_PRINT_LINUX_SYSTEM_LIBRARIES = %w[
ld-linux
Expand Down Expand Up @@ -38,7 +38,7 @@ namespace :package do
FileUtils.mkdir_p(File.join(root, "pkg"))

sh "git clone --depth 1 --branch #{PAGE_PRINT_PLUTOBOOK_VERSION.shellescape} https://github.com/plutoprint/plutobook.git #{plutobook_source_dir.shellescape}"
sh "meson setup #{plutobook_build_dir.shellescape} #{plutobook_source_dir.shellescape} --prefix=#{plutobook_install_dir.shellescape} --libdir=lib --buildtype=release --force-fallback-for=harfbuzz -Dcurl=disabled -Dturbojpeg=disabled -Dwebp=disabled -Dtools=disabled -Dtests=disabled -Dexamples=disabled"
sh "meson setup #{plutobook_build_dir.shellescape} #{plutobook_source_dir.shellescape} --prefix=#{plutobook_install_dir.shellescape} --libdir=lib --buildtype=release -Dcpp_args=\"['-include', 'memory_resource']\" --force-fallback-for=harfbuzz -Dcurl=disabled -Dturbojpeg=disabled -Dwebp=disabled -Dtools=disabled -Dtests=disabled -Dexamples=disabled"
sh "meson compile -C #{plutobook_build_dir.shellescape}"
sh "meson install -C #{plutobook_build_dir.shellescape}"

Expand Down
Loading