From 4af8a606a15e93a7272c1ee2f79b6e303bf4147b Mon Sep 17 00:00:00 2001 From: tegwick Date: Wed, 8 Jul 2026 14:31:33 +0200 Subject: [PATCH] Seeded INTENT.md and stuff --- AGENTS.md | 176 +++++++++++++++++++ INTENT.md | 24 +++ SCOPE.md | 39 ++++ workplans/TMLN-WP-0001-statehub-bootstrap.md | 59 +++++++ 4 files changed, 298 insertions(+) create mode 100644 AGENTS.md create mode 100644 INTENT.md create mode 100644 SCOPE.md create mode 100644 workplans/TMLN-WP-0001-statehub-bootstrap.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..90d301e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,176 @@ +# timeline-svg — Agent Instructions + +## Repo Identity + +**Purpose:** TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline. + +**Domain:** infotech +**Repo slug:** timeline-svg +**Topic ID:** `cee7bedf-2b48-46ef-8601-006474f2ad7a` +**Workplan prefix:** `TMLN-WP-` + +--- + +## State Hub Integration + +The Custodian State Hub tracks work across all domains. Interact via HTTP REST — +there is no MCP server for Codex agents. + +| Context | URL | +|---------|-----| +| Local workstation | `http://127.0.0.1:8000` | +| Remote via tunnel | `http://127.0.0.1:18000` | +| Optional local edge relay | http://127.0.0.1:18080 | + +When an operator has enabled the edge relay, set API_BASE to the relay URL. +Queueable writes return an explicit queued receipt if the central hub is +unreachable. Treat that as pending local evidence, then ask the operator to run +statehub outbox status/replay after connectivity returns. + +### Orient at session start + +```bash +# Offline brief — works without hub connection +cat .custodian-brief.md + +# Active workplans for this domain +curl -s "http://127.0.0.1:8000/workplans/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" \ + | python3 -m json.tool + +# Check inbox +curl -s "http://127.0.0.1:8000/messages/?to_agent=timeline-svg&unread_only=true" \ + | python3 -m json.tool +``` + +Mark a message read: +```bash +curl -s -X PATCH "http://127.0.0.1:8000/messages//read" \ + -H "Content-Type: application/json" -d '{}' +``` + +### Log progress (required at session close) + +```bash +curl -s -X POST http://127.0.0.1:8000/progress/ \ + -H "Content-Type: application/json" \ + -d '{ + "summary": "what was done", + "event_type": "note", + "author": "codex", + "workplan_id": "", + "task_id": "" + }' +``` + +Omit `workplan_id` / `task_id` when not applicable. + +### Update task status + +```bash +curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ + -H "Content-Type: application/json" \ + -d '{"status": "progress"}' +# values: wait | todo | progress | done | cancel +``` + +### Flag a task for human review + +```bash +curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ + -H "Content-Type: application/json" \ + -d '{"needs_human": true, "intervention_note": "reason"}' +``` + +--- + +## Session Protocol + +**Start:** +1. `cat .custodian-brief.md` — domain goal and open workplans (offline-safe) +2. Check inbox: `GET /messages/?to_agent=timeline-svg&unread_only=true`; mark read +3. Scan workplans: `ls workplans/` — note `status: ready`, `active`, or `blocked` files and open tasks +4. Check human-needed tasks: `GET /tasks/?needs_human=true` + +**During work:** +- Update task statuses in workplan files as tasks progress +- Record significant decisions via `POST /decisions/` + +**Close:** +1. Update workplan file task statuses to reflect progress +2. Log: `POST /progress/` with a summary of what changed +3. After workplan file changes, run: + ```bash + statehub fix-consistency + ``` + Coding agents should run this directly; ask the operator only if the CLI or + State Hub API is unavailable. This syncs task status from files into the hub DB. + +--- + +{CREDENTIAL_ROUTING} + + + + +--- + +## Workplan Convention (ADR-001) + +Work items originate as files in this repo — not in the hub. The hub is a +read/cache/index layer that rebuilds from files. + +**File location:** `workplans/TMLN-WP-NNNN-.md` + +**Archived location:** finished workplans may move to +`workplans/archived/YYMMDD-TMLN-WP-NNNN-.md`. The `YYMMDD` prefix is +the completion/archive date; the frontmatter `id` does not change. + +**Ad Hoc Tasks:** small opportunistic fixes discovered during a session use +`workplans/ADHOC-YYYY-MM-DD.md` with task ids `ADHOC-YYYY-MM-DD-T01`, etc. Use +this only for low-risk work completed directly; create a normal workplan for +anything needing analysis, design, approval, dependencies, or multiple phases. + +**Frontmatter:** + +```yaml +--- +id: TMLN-WP-NNNN +type: workplan +title: "..." +domain: infotech +repo: timeline-svg +status: proposed | ready | active | blocked | backlog | finished | archived +owner: codex +topic_slug: ... +created: "YYYY-MM-DD" +updated: "YYYY-MM-DD" +state_hub_workstream_id: "" # written by fix-consistency — do not edit (legacy name; holds the workplan id) +--- +``` + +Use `proposed` for a new draft, `ready` after review against current repo +state, and `finished` after implementation. `stalled` and `needs_review` are +derived health labels, not frontmatter statuses. + +**Task block format** (one per `##` section): + +``` +## Task Title + +` ` `task +id: TMLN-WP-NNNN-T01 +status: wait | todo | progress | done | cancel +priority: high | medium | low +state_hub_task_id: "" # written by fix-consistency — do not edit +` ` ` + +Task description text. +``` + +Status progression: `todo` → `progress` → `done`; use `wait` for waiting/blocked work and `cancel` for stopped work. + +To create a new workplan: +1. Write the file following the format above +2. Run `statehub fix-consistency` locally; ask the operator only if the CLI or + State Hub API is unavailable. diff --git a/INTENT.md b/INTENT.md new file mode 100644 index 0000000..7b47c03 --- /dev/null +++ b/INTENT.md @@ -0,0 +1,24 @@ +--- +repo: timeline-svg +updated: "2026-07-08" +--- + +# INTENT + +## Why it exists + +TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline. + +**TimelineSvg** is a lightweight, browser-based system for generating multi-lane timelines as clean, scalable SVG graphics. It reads simple CSV files, applies a configurable project definition, and renders a fully customizable timeline without requiring any backend or build pipeline. + +## Governing principle + +This repository should stay focused on the purpose above. Work that changes its +authority, ownership boundaries, or operational promises should be captured in a +workplan before implementation. + +## What it enables + +- A coding agent can understand why the repository exists before changing it. +- State Hub can register and coordinate work for this repository. +- Future workplans can stay connected to the repository's intended role. diff --git a/SCOPE.md b/SCOPE.md new file mode 100644 index 0000000..65b9357 --- /dev/null +++ b/SCOPE.md @@ -0,0 +1,39 @@ +# SCOPE + +> This file was generated by `statehub register`. Refine it as the repository +> boundaries become clearer. + +## One-liner + +TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline. + +## Core Idea + +timeline-svg exists to provide the capability described in INTENT.md. + +## In Scope + +- Parsing CSV data into timeline items with configurable field mappings +- Rendering multi-lane SVG timelines via a template-v2 (DOM-based) architecture +- Supporting Inkscape/Illustrator/Figma-editable SVG templates with placeholder substitution +- Providing a browser UI (index.html/engine.js) for loading projects, previewing, and exporting SVGs +- In-browser inline file editing with modification tracking +- Vitest-based test suite covering generator, engine, and integration flows +- Distribution packaging (make dist/dist-zip) for offline/Windows deployment + +## Out of Scope + +- Server-side or backend processing (fully client-side by design) +- Build pipeline or bundler-based tooling +- Non-timeline visualization types (e.g., Gantt-specific scheduling logic beyond basic lanes/items) +- Authentication, multi-user collaboration, or persistence beyond local files + +## Current State + +- {"project_description": "TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline.", "intent_markdown": null, "domain_slug": "infotech", "topic_slug": "timeline-svg", "topic_title": "TimelineSvg - CSV-to-SVG Timeline Generator", "repo_slug": "timeline-svg", "workplan_prefix": "TMLN-WP", "in_scope": ["Parsing CSV data into timeline items with configurable field mappings", "Rendering multi-lane SVG timelines via a template-v2 (DOM-based) architecture", "Supporting Inkscape/Illustrator/Figma-editable SVG templates with placeholder substitution", "Providing a browser UI (index.html/engine.js) for loading projects, previewing, and exporting SVGs", "In-browser inline file editing with modification tracking", "Vitest-based test suite covering generator, engine, and integration flows", "Distribution packaging (make dist/dist-zip) for offline/Windows deployment"], "out_of_scope": ["Server-side or backend processing (fully client-side by design)", "Build pipeline or bundler-based tooling", "Non-timeline visualization types (e.g., Gantt-specific scheduling logic beyond basic lanes/items)", "Authentication, multi-user collaboration, or persistence beyond local files"], "current_state": "Actively developed local tool with recent work on a DOM-based prototype template system and inline file editing; test suite and CI smoke workflow (Forgejo) exist; no formal INTENT.md yet."} + +## Getting Oriented + +- Start with: INTENT.md +- Agent instructions: AGENTS.md +- Workplans: workplans/ diff --git a/workplans/TMLN-WP-0001-statehub-bootstrap.md b/workplans/TMLN-WP-0001-statehub-bootstrap.md new file mode 100644 index 0000000..3b09281 --- /dev/null +++ b/workplans/TMLN-WP-0001-statehub-bootstrap.md @@ -0,0 +1,59 @@ +--- +id: TMLN-WP-0001 +type: workplan +title: "Bootstrap State Hub integration" +domain: infotech +repo: timeline-svg +status: ready +owner: codex +topic_slug: custodian +created: "2026-07-08" +updated: "2026-07-08" +state_hub_workstream_id: "723b43c9-86d9-4872-b7ae-cd8a10791ef1" +--- + +# Bootstrap State Hub integration + +TimelineSvg is a client-side, browser-based tool that generates multi-lane SVG timeline graphics from CSV data using an Inkscape-editable SVG template system with no backend or build pipeline. + +## Review Generated Integration Files + +```task +id: TMLN-WP-0001-T01 +status: todo +priority: high +state_hub_task_id: "6fced395-2061-4c81-b77b-e83bdd0e7aea" +``` + +Review `INTENT.md`, `SCOPE.md`, `AGENTS.md`, and `.custodian-brief.md`. +Replace generated placeholders with repo-specific facts where needed. + +## Verify Local Developer Workflow + +```task +id: TMLN-WP-0001-T02 +status: todo +priority: high +state_hub_task_id: "0422d117-cc07-4aa1-82e4-52179e08c790" +``` + +Identify the repo's install, test, lint, build, and run commands. Add or refine +those commands in the agent instructions so future coding sessions can verify +changes confidently. + +## Seed First Real Workplan + +```task +id: TMLN-WP-0001-T03 +status: todo +priority: medium +state_hub_task_id: "3b7c0d8e-6321-470c-b032-9fc0fcfb970c" +``` + +Create the first implementation workplan for the repository's most important +next change. After workplan file updates, run the sync locally from this repo +checkout: + +```bash +statehub fix-consistency +```