chore: adopt .dev/ project-notes convention (pilot) — seeded from the 2026-07-05 deep review - #72
Conversation
- Rename dev-notes/ -> .dev/ (PLAN.md, FUTURE.md, ARCHITECTURE.md + immutable archive/) - .dev/PLAN.md: phased maintenance plan from the 2026-07-05 deep technical review (8 phases: patch release, parser/validation, CLI state, security, tests/CI, consolidation refactors, docs currency, issue gardening) - .dev/FUTURE.md: 12 documented feature ideas (auto-merge+digest, per-language models, metadata contract, MyST lint, correction capture, prompt caching, and carried-forward items from the archived plan) - .dev/ARCHITECTURE.md: system snapshot, recommendations R1-R7, open questions (repo topology, mystmd builder migration, whole-file vs section translation), seeded decision log - Archive the completed 2026-03 resync-CLI plan and the issue-63 rebase design record (its unbuilt Stage 2 auto-merge spec moved to FUTURE.md) - Add root AGENTS.md pointing agents at .dev/ and core commands - Update dev-notes references in copilot-instructions.md and docs/projects/README.md Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- Add .dev/DECISIONS.md: append-only micro-ADR decision log (Decision/Why/ Rejected/Refs), seeded with 9 entries distilled from project history, including the decision to adopt this format itself - Delete .dev/archive/ — completed plans and shipped design records now live in git history (dev-notes/PLAN.md, dev-notes/FIX-ISSUE-63.md); their load-bearing content was already extracted into FUTURE.md/ARCHITECTURE.md/PLAN.md - ARCHITECTURE.md: decision log moved out; open questions now close into DECISIONS.md - Update convention in .dev/README.md (delete-after-distilling lifecycle, single-file vs decisions/ folder graduation path) and AGENTS.md pointers Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR replaces the legacy dev-notes/ directory with a standardized .dev/ working-notes convention and adds a root AGENTS.md to direct coding agents/maintainers to the new plan/decision artifacts. It aligns internal references to the new locations while removing the old note files (with history preserved in git).
Changes:
- Introduces
.dev/as the canonical home for working notes:PLAN.md,FUTURE.md,ARCHITECTURE.md,DECISIONS.md, plus.dev/README.mddescribing the convention. - Adds
AGENTS.mdat repo root to point agents to.dev/and common repo commands/rules. - Updates internal doc references and removes the old
dev-notes/files.
Reviewed changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/projects/README.md | Updates related-doc link to point at .dev/ARCHITECTURE.md instead of dev-notes/PLAN.md. |
| dev-notes/README.md | Deletes legacy developer-notes index (superseded by .dev/README.md). |
| dev-notes/PLAN.md | Deletes legacy roadmap (content distilled into new .dev/* docs; full text remains in git history). |
| dev-notes/FIX-ISSUE-63.md | Deletes legacy issue-63 fix write-up (distilled into .dev/DECISIONS.md / .dev/FUTURE.md; history preserved). |
| AGENTS.md | Adds a root pointer for agents/maintainers to .dev/ and key repo commands/rules. |
| .github/copilot-instructions.md | Updates release checklist reference from dev-notes/PLAN.md to .dev/PLAN.md. |
| .dev/README.md | Adds documentation for the .dev/ convention, structure, and update rules. |
| .dev/PLAN.md | Adds the new active maintenance plan seeded from the technical review. |
| .dev/FUTURE.md | Adds a curated set of documented feature ideas for later iteration. |
| .dev/DECISIONS.md | Adds an append-only micro-ADR log seeded with key historical decisions. |
| .dev/ARCHITECTURE.md | Adds an architecture snapshot, recommendations, and open design questions. |
| - **Fixed filenames** — agents and instruction files (`AGENTS.md`, `CLAUDE.md`, | ||
| `.github/copilot-instructions.md`) can point at stable paths. |
…health check) Upgrades PR #72 to the .dev/ pilot design (#73, QuantEcon/QuantEcon.manual#103): - Add STATE.md (living, `verified:`, 1-page snapshot; entry point) - Split DECISIONS.md into decisions/ (11 files, date+slug ids, scope + superseded_by frontmatter); the single-file choice is recorded as superseded to exercise the mechanism - Add log/ with the first session entry, carrying pilot feedback as promote: items - Keep FUTURE.md/ARCHITECTURE.md as additional living docs - Add deterministic pass-1 health check (.dev/tools/check.mjs, no deps) enforcing the 4-key frontmatter schema (errors) + staleness/size/signal (warnings), wired as .github/workflows/dev-notes-check.yml (on .dev/** PRs, weekly, dispatch) - Add the .dev/ contract to AGENTS.md; rewrite .dev/README.md for the pilot layout Deviations from the spec are recorded as decisions + promote feedback: date+slug decision ids (collision-free under parallel agents), scratch stays in .tmp/, and FUTURE/ARCHITECTURE retained as living docs. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Reworks the pilot to the simplified convention (QuantEcon/QuantEcon.manual#103 rev 3, #73): complexity must be earned by observed pain, not installed in anticipation of it. - Remove the machinery: .dev/tools/check.mjs, dev-notes-check.yml workflow, and all YAML frontmatter - STATE.md: plain 'verified: YYYY-MM-DD' first line - decisions/: renamed to D-YYYY-MM-DD-<slug>.md, reshaped to context/decision/consequences, pruned same-day meta-churn (9 real decisions remain); supersession is now a note at the top of the old file - log/: inline #promote tags replace the promote: frontmatter list - Scratch migrated .tmp/ -> .dev/scratch/ (gitignore, copilot-instructions, AGENTS.md); .tmp/ left ignored as a retired legacy path - Security: rebase-mode metadata finding redacted per the public-content rule and pulled forward to PLAN Phase 1.5 - ci.yml: paths-ignore ['.dev/**'] (safe: no required checks; caveat noted inline), .dev/README.md + AGENTS.md contract rewritten to the lightweight spec Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
STATE.md listed PR #68 (fr) as open/awaiting review with a missing LANGUAGE_CONFIGS entry, but it merged 2026-07-14 with its config wiring. Move fr to "Recently landed", update Health & context, bump verified date. ARCHITECTURE.md R2 described the rebase PR-body channel as an "input surface whose validation is being hardened in PLAN Phase 1.5" — more trust-boundary detail than the .dev/ public-content rule wants while the fix is unshipped. Drop that clause; keep the engineering rationale (cap, editability, staleness). Add a log entry per the AGENTS.md contract. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Review summary — approved ✅Docs/process-only change (no source touched); low risk — nothing here ships to npm, the action bundle, or the docs site. Verified on the branch that the What's done well
Fixes applied in
Left for the author's call (not blocking): Merging. |
Summary
Establishes
action-translationas the pilot repo for the QuantEcon.dev/project-notes convention (pilot: #73; spec: QuantEcon/QuantEcon.manual#103), seeded with the full output of the 2026-07-05 deep technical review (all source, tests, CI, docs, issues, and PRs)..dev/is a lightweight, tool-agnostic folder for state, decisions, and design ideas, maintained jointly by humans and coding agents. Plain markdown only — no YAML schema, no CI gates; structure lives in filenames, git, and three plain-text conventions (averified:first line in STATE.md, supersession notes in old decision files, inline#promotetags for cross-repo findings). Design rule from the spec: complexity must be earned by observed pain, not installed in anticipation of it.Structure
The agent contract lives in
AGENTS.md; the convention itself is documented in.dev/README.md.Notes for review
DECISIONS.md+ archive folder, then a full-mechanism cut (YAML frontmatter, deterministic health check + CI workflow), then this final simplified form after the spec revision. The intermediate machinery is preserved in git history and in manual#103's edit history if evidence of need ever emerges — the "tidy.dev/" session workflow is the probe for that..tmp/→.dev/scratch/per the pilot spec (adoption step 2);copilot-instructions.mdand.gitignoreupdated,.tmp/left ignored as a retired legacy path so stale local copies stay invisible.paths-ignore: ['.dev/**']added per the spec — safe today becausemainhas no required status checks; an inline comment notes to drop the ignore iftestever becomes required (a skipped required check would deadlock.dev-only PRs).🤖 Generated with Claude Code