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. - 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.
- Move a project to
DOCS/PROJECTS/in-review/and setstatus: in-reviewwhen implementation is complete but walkthrough/sign-off has not happened yet. - Move a project to
DOCS/PROJECTS/blocked/and setstatus: blockedwhen waiting on user decisions, permissions, access, or missing inputs. - Do not move a project to
DOCS/PROJECTS/completed/until collaborative walkthrough/sign-off is complete. - While projects are in
in-revieworblocked, continue execution by pulling the next prioritized backlog/stale stream. - 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
- Docs index:
DOCS/README.md - Docs home:
DOCS/index.md - Local docs site wrapper:
docs-site/ - Route governance checklist:
DOCS/development/route-governance-checklist.md
Provenance
- Source file:
AGENTS.md - Source URL: https://github.com/maggielerman/smc-directory/blob/main/AGENTS.md
Dataset Preview
- Raw CSV row/table content is available in the source artifact.