Add project AGENTS.md to replace stale LLM_SYSTEM_PROMPT.md #3

Closed
opened 2026-09-10 03:25:50 +00:00 by agent-pi · 1 comment
Collaborator

Problem

The repo's only agent-instructions file, LLM_SYSTEM_PROMPT.md, is stale:

  • It points at Codeberg, but the project lives on forge.marvin8.zone.
  • It pre-dates both the abandonment and the LLM-revival direction (issue #1).
  • It doesn't match current tooling (uv-ship/calver releases, prek, nox-uv, complexipy, docs dependency group).

Agents (pi included) read AGENTS.md natively. The project should have one canonical, current instructions file so agent behaviour is consistent across sessions and machines.

## Problem The repo's only agent-instructions file, `LLM_SYSTEM_PROMPT.md`, is stale: - It points at Codeberg, but the project lives on forge.marvin8.zone. - It pre-dates both the abandonment and the LLM-revival direction (issue #1). - It doesn't match current tooling (uv-ship/calver releases, prek, nox-uv, complexipy, docs dependency group). Agents (pi included) read `AGENTS.md` natively. The project should have one canonical, current instructions file so agent behaviour is consistent across sessions and machines.
Author
Collaborator

Plan of attack

  1. Add AGENTS.md scoped to yunjin-specific guidance only — the global ~/.pi/agent/AGENTS.md on the agent box already covers import style, docstrings, dependency pinning, TDD, the forge workflow, and the main-off-limits invariant; none of that is duplicated here.
  2. Contents: repo location and no-CI note, tooling commands (uv/pytest/ruff/ty; prek and nox human-only), architecture map (services → raw-SQL db → Flask web; alembic), project conventions (httpx not requests, minimal JS, deuteranopia-safe palettes, async I/O), hands-off files (CHANGELOG.md, ruff.toml, RELEASE_NOTES_*.md), uv-ship release flow, and the LLM direction pointer (issue #1) with env-var config naming (YUNJIN_LLM_API_KEY / YUNJIN_LLM_BASE_URL / YUNJIN_LLM_MODEL, keys from env only).
  3. Delete LLM_SYSTEM_PROMPT.md in the same PR.
  4. README and Roadmap "abandoned" notices stay as-is until the LLM service lands (decided with Marvin8).

Branch: docs/issue-3-add-agents-md

Commits:

  • :memo: Replace LLM_SYSTEM_PROMPT.md with project AGENTS.md

PR: opened via the Forgejo API targeting main, body with Closes #3.

## Plan of attack 1. Add `AGENTS.md` scoped to yunjin-specific guidance only — the global `~/.pi/agent/AGENTS.md` on the agent box already covers import style, docstrings, dependency pinning, TDD, the forge workflow, and the main-off-limits invariant; none of that is duplicated here. 2. Contents: repo location and no-CI note, tooling commands (uv/pytest/ruff/ty; prek and nox human-only), architecture map (services → raw-SQL db → Flask web; alembic), project conventions (httpx not requests, minimal JS, deuteranopia-safe palettes, async I/O), hands-off files (`CHANGELOG.md`, `ruff.toml`, `RELEASE_NOTES_*.md`), uv-ship release flow, and the LLM direction pointer (issue #1) with env-var config naming (`YUNJIN_LLM_API_KEY` / `YUNJIN_LLM_BASE_URL` / `YUNJIN_LLM_MODEL`, keys from env only). 3. Delete `LLM_SYSTEM_PROMPT.md` in the same PR. 4. README and Roadmap "abandoned" notices stay as-is until the LLM service lands (decided with Marvin8). Branch: `docs/issue-3-add-agents-md` Commits: - `:memo: Replace LLM_SYSTEM_PROMPT.md with project AGENTS.md` PR: opened via the Forgejo API targeting `main`, body with `Closes #3`.
Sign in to join this conversation.
No labels
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
marvin8/yunjin#3
No description provided.