AGENTS
Agent Instructions These instructions apply to all AI assistants working in this repository. Core Rules - Always review CHANGELOG. Imported Co...
Agent Instructions These instructions apply to all AI assistants working in this repository. ## Core Rules - Always review `CHANGELOG.
Agent Instructions
These instructions apply to all AI assistants working in this repository.
Core Rules
- Always review
CHANGELOG.mdandROADMAP.mdbefore starting significant work. - Treat the docs root (
DOCS/ordocs/) as the documentation source of truth. - Before code changes, load required context from
docs/README.mdand the critical docs list below. - Update docs when code changes affect behavior, workflows, or interfaces.
- Maintain frontmatter (
title,description,status,lastUpdated,owner). - Keep
docs/README.mdanddocs/index.mdaccurate. - Use checkpoint-based progress updates instead of
today/tomorrowhandoff wording. - Generate timestamps with
node scripts/docs/timestamp-et.mjs --json(never hand-type them). - Each project update must include:
- absolute timestamp (
YYYY-MM-DD HH:MM ET (America/New_York)) - completed since prior checkpoint
- next checkpoint targets
- absolute timestamp (
Project Planning
- Create a numbered project doc under
docs/PROJECTS/active/at project kickoff. - Move the doc across status folders as work progresses.
- Reference the project number in roadmap and changelog entries.
- Maintain a checkpoint log in each project doc and add a checkpoint for major decisions, delivery milestones, or scope changes.
Docs Site
- Local dev:
npm --prefix docs-site run dev - Build:
npm --prefix docs-site run build - Cloudflare Pages: Root Directory repo root, Build command
npm --prefix docs-site run build, Build output directorydocs/.vitepress/dist
Documentation
- Canonical docs root:
docs/ - VitePress home:
docs/index.md - Source-of-truth index:
docs/README.md
Required Context Docs
- Product behavior and current scope:
docs/features/FEATURES.md - Codebase layout and file map:
docs/development/APP_STRUCTURE.md - System architecture, schema, and data flow:
docs/development/ARCHITECTURE.md - AI pipelines, prompts, and scoring:
docs/development/AI_COMPONENTS.md - Deployment and local/self-hosted operations:
docs/deployment/SELF_HOSTING.md - Product and business framing:
docs/features/LEAN_CANVAS.md - Historical decisions and build timeline:
docs/historical/PROMPT_HISTORY.md - Original intent and constraints:
docs/historical/FIRST_PROMPT.md
Startup Read Order
- Baseline onboarding:
docs/README.md - Core product and architecture:
docs/features/FEATURES.md,docs/development/APP_STRUCTURE.md,docs/development/ARCHITECTURE.md - Task-specific deep dive (AI work):
docs/development/AI_COMPONENTS.md - Task-specific deep dive (infra/deployment):
docs/deployment/SELF_HOSTING.md - Task-specific deep dive (historical/debug context):
docs/historical/PROMPT_HISTORY.md
Provenance
- Source file:
AGENTS.md - Source URL: https://github.com/maggielerman/project-compass/blob/main/AGENTS.md