generated from coulomb/repo-seed
Organize generic docs and Coulomb MVP project layout
Move the framework PRD from specs/ to docs/ and remove the misplaced specs/ directory. Document repository layout in AGENTS.md and SCOPE.md: generic material in docs/, project-specific MVP artifacts in projects/coulomb-pricing/, execution tracking in workplans/.
This commit is contained in:
182
AGENTS.md
Normal file
182
AGENTS.md
Normal file
@@ -0,0 +1,182 @@
|
|||||||
|
# adaptive-pricing — Agent Instructions
|
||||||
|
|
||||||
|
## Repo Identity
|
||||||
|
|
||||||
|
**Purpose:** Auto-regulating market value exploring price engine.
|
||||||
|
|
||||||
|
**Domain:** helix_forge
|
||||||
|
**Repo slug:** adaptive-pricing
|
||||||
|
**Topic ID:** `f39fa2a3-c491-414c-a91b-b4c5fcc6139c`
|
||||||
|
**Workplan prefix:** `ADAPTIVE-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` |
|
||||||
|
|
||||||
|
### Orient at session start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Offline brief — works without hub connection
|
||||||
|
cat .custodian-brief.md
|
||||||
|
|
||||||
|
# Active workstreams for this domain
|
||||||
|
curl -s "http://127.0.0.1:8000/workstreams/?topic_id=f39fa2a3-c491-414c-a91b-b4c5fcc6139c&status=active" \
|
||||||
|
| python3 -m json.tool
|
||||||
|
|
||||||
|
# Check inbox
|
||||||
|
curl -s "http://127.0.0.1:8000/messages/?to_agent=adaptive-pricing&unread_only=true" \
|
||||||
|
| python3 -m json.tool
|
||||||
|
```
|
||||||
|
|
||||||
|
Mark a message read:
|
||||||
|
```bash
|
||||||
|
curl -s -X PATCH "http://127.0.0.1:8000/messages/<id>/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",
|
||||||
|
"workstream_id": "<uuid>",
|
||||||
|
"task_id": "<uuid>"
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
Omit `workstream_id` / `task_id` when not applicable.
|
||||||
|
|
||||||
|
### Update task status
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||||
|
-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/<task_id>" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"needs_human": true, "intervention_note": "reason"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Session Protocol
|
||||||
|
|
||||||
|
**Start:**
|
||||||
|
1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe)
|
||||||
|
2. Check inbox: `GET /messages/?to_agent=adaptive-pricing&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. Note for the custodian operator: after workplan file changes, run from
|
||||||
|
`~/state-hub`:
|
||||||
|
```bash
|
||||||
|
make fix-consistency REPO=adaptive-pricing
|
||||||
|
```
|
||||||
|
This syncs task status from files into the hub DB.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
{CREDENTIAL_ROUTING}
|
||||||
|
|
||||||
|
<!-- REPO-AGENTS-EXTENSIONS -->
|
||||||
|
<!-- Append repo-specific agent instructions below this marker.
|
||||||
|
The state-hub template sync preserves content after this line. -->
|
||||||
|
|
||||||
|
## Repository Layout
|
||||||
|
|
||||||
|
| Path | Purpose |
|
||||||
|
|------|---------|
|
||||||
|
| `INTENT.md`, `docs/`, `research/`, `registry/` | Generic adaptive-pricing framework |
|
||||||
|
| `projects/<slug>/` | Deployment-specific MVP material (integrations, configs, project docs) |
|
||||||
|
| `workplans/` | ADR-001 workplans and task tracking (including MVP execution plans) |
|
||||||
|
|
||||||
|
Do not place project-specific MVP documentation in `specs/` or other generic
|
||||||
|
paths. The Coulomb Social MVP lives under `projects/coulomb-pricing/`; its
|
||||||
|
workplan remains `workplans/ADAPTIVE-WP-0002-economic-observatory-mvp.md`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 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/ADAPTIVE-WP-NNNN-<slug>.md`
|
||||||
|
|
||||||
|
**Archived location:** finished workplans may move to
|
||||||
|
`workplans/archived/YYMMDD-ADAPTIVE-WP-NNNN-<slug>.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: ADAPTIVE-WP-NNNN
|
||||||
|
type: workplan
|
||||||
|
title: "..."
|
||||||
|
domain: helix_forge
|
||||||
|
repo: adaptive-pricing
|
||||||
|
status: proposed | ready | active | blocked | backlog | finished | archived
|
||||||
|
owner: codex
|
||||||
|
topic_slug: ...
|
||||||
|
created: "YYYY-MM-DD"
|
||||||
|
updated: "YYYY-MM-DD"
|
||||||
|
state_hub_workstream_id: "<uuid>" # written by fix-consistency — do not edit
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
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: ADAPTIVE-WP-NNNN-T01
|
||||||
|
status: wait | todo | progress | done | cancel
|
||||||
|
priority: high | medium | low
|
||||||
|
state_hub_task_id: "<uuid>" # 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. Notify the custodian operator to run `make fix-consistency REPO=adaptive-pricing`
|
||||||
|
(or send a message to the hub agent via `POST /messages/`)
|
||||||
38
SCOPE.md
Normal file
38
SCOPE.md
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
# SCOPE
|
||||||
|
|
||||||
|
> This file was generated by `statehub register`. Refine it as the repository
|
||||||
|
> boundaries become clearer.
|
||||||
|
|
||||||
|
## One-liner
|
||||||
|
|
||||||
|
Auto-regulating market value exploring price engine.
|
||||||
|
|
||||||
|
## Core Idea
|
||||||
|
|
||||||
|
adaptive-pricing exists to provide the capability described in INTENT.md.
|
||||||
|
|
||||||
|
## In Scope
|
||||||
|
|
||||||
|
- Maintain the repository's primary implementation.
|
||||||
|
- Keep docs, tests, and operational metadata current.
|
||||||
|
- Generic framework documentation (`INTENT.md`, `docs/`, `research/`, `registry/`).
|
||||||
|
- Project-specific deployments under `projects/<slug>/`.
|
||||||
|
|
||||||
|
## Out of Scope
|
||||||
|
|
||||||
|
- Own unrelated adjacent systems.
|
||||||
|
- Make irreversible operational decisions without human approval.
|
||||||
|
- Project-specific MVP material in `specs/` or other generic doc paths (use
|
||||||
|
`projects/<slug>/` instead).
|
||||||
|
|
||||||
|
## Current State
|
||||||
|
|
||||||
|
- Status: active; implementation and stability should be verified by the repo agent.
|
||||||
|
|
||||||
|
## Getting Oriented
|
||||||
|
|
||||||
|
- Start with: INTENT.md
|
||||||
|
- Product requirements (generic): docs/ProductRequirementsDocument.md
|
||||||
|
- Agent instructions: AGENTS.md
|
||||||
|
- Workplans: workplans/
|
||||||
|
- Coulomb MVP artifacts: projects/coulomb-pricing/
|
||||||
1228
docs/ProductRequirementsDocument.md
Normal file
1228
docs/ProductRequirementsDocument.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -4,6 +4,9 @@ Project-specific material for the Coulomb Social Economic Observatory MVP.
|
|||||||
|
|
||||||
This directory holds implementation artifacts, integrations, and documentation that
|
This directory holds implementation artifacts, integrations, and documentation that
|
||||||
apply to the Coulomb deployment only. Generic adaptive-pricing framework concepts
|
apply to the Coulomb deployment only. Generic adaptive-pricing framework concepts
|
||||||
belong in the repository root (`INTENT.md`, `research/`, `registry/`, etc.).
|
belong in the repository root (`INTENT.md`, `docs/`, `research/`, `registry/`).
|
||||||
|
|
||||||
Tracked workplan: `workplans/ADAPTIVE-WP-0002-economic-observatory-mvp.md`.
|
**Execution tracking:** `workplans/ADAPTIVE-WP-0002-economic-observatory-mvp.md`
|
||||||
|
|
||||||
|
**Strategic positioning:** Adaptive Pricing is the pricing capability layer for
|
||||||
|
Coulomb offerings and related product ecosystems.
|
||||||
Reference in New Issue
Block a user