AGENTS.md · diff

git:20260429.4796ed8 to git:20260511.cf07fca

35 added, 33 removed. Audit A to A.

- # Pascal Agent Instructions
-
- This repository uses shared architecture rules for AI assistants. Treat the rule files as the source of truth for architecture-sensitive work.
+ # Agent Instructions — `pascalorg/editor`
- ## Required Rule Sources
+ Public, open-source home of `@pascal-app/{core,viewer,editor,mcp}` and the standalone editor app. Consumed both as npm packages and (in `pascalorg/private-editor`) as a git submodule.
- The canonical rules live in `.cursor/rules/*.mdc`.
+ ## Repo Shape
- Claude-compatible paths are exposed in `.claude/rules/*.md`.
- Codex-compatible paths are exposed in `.codex/rules/*.md`.
+ | Path | Purpose |
+ |---|---|
+ | `packages/core` | Scene graph, node schemas, stores, event bus, core systems — pure logic, no Three.js |
+ | `packages/viewer` | Standalone 3D canvas: renderers, viewer systems, presentation state |
+ | `packages/editor` | Editor UI components reused by the standalone app and embedders |
+ | `packages/mcp` | MCP server and scene storage adapters |
+ | `apps/editor` | Standalone editor app — composes `viewer` + `editor` + tools |
- Both should point to the same Cursor rule sources so Claude and Codex review the exact same rules.
+ ## Where to look
- ## Architecture Rules
+ - **Architecture rules** — `wiki/architecture/` (read on demand; index in `wiki/architecture/README.md`).
+ - **Skills (ready workflows)** — `.agents/skills/<name>/SKILL.md`. Same content is reachable as `.claude/skills/`, `.cursor/skills/`, `.codex/skills/` (symlinks to `.agents/skills/`).
+ - **Repo orientation for humans** — `README.md`, `SETUP.md`, `CONTRIBUTING.md`.
- Read the relevant rules before making or reviewing changes in these areas:
+ `CLAUDE.md`, `GEMINI.md`, and `.github/copilot-instructions.md` are symlinks to this file. Codex reads this file directly.
- - `.codex/rules/systems.md` — core systems vs viewer systems, what each may do
- - `.codex/rules/renderers.md` — renderer responsibilities and prohibitions
- - `.codex/rules/tools.md` — editor tools live only in `apps/editor/components/tools/`
- - `.codex/rules/viewer-isolation.md` — viewer must stay editor-agnostic
- - `.codex/rules/layers.md`
- - `.codex/rules/selection-managers.md`
- - `.codex/rules/scene-registry.md`
- - `.codex/rules/spatial-queries.md`
- - `.codex/rules/node-schemas.md`
- - `.codex/rules/events.md`
+ ## Layer Boundaries (read once, internalise)
- For architecture reviews, the first four are always required. Read the remaining rules when the diff touches their subject area.
+ - **`packages/core`** owns domain data and pure logic. It must not import Three.js, `packages/viewer`, `apps/editor`, rendering/UI concepts, tools, modes, phases, or view-specific concepts such as floorplan or paint preview.
+ - **`packages/viewer`** owns the standalone 3D canvas, renderers, viewer systems, and genuine presentation state. It must not know about `useEditor`, editor tools, phases, modes, paint mode, floorplan state, or editor-only presentation vocabulary.
+ - **`apps/editor`** owns the editing experience: tools, `useEditor`, panels, floorplan helpers, paint mode, keyboard shortcuts, command palette, action menus, cursor badges, and editor-only overlays. Editor features are injected into `<Viewer>` via props and children.
- ## Layer Boundaries
+ Details, examples, and rationale live in `wiki/architecture/layers.md`, `wiki/architecture/viewer-isolation.md`, `wiki/architecture/systems.md`, `wiki/architecture/renderers.md`, `wiki/architecture/tools.md`.
- `packages/core` owns domain data and pure logic. It must not import Three.js, `packages/viewer`, `apps/editor`, rendering/UI concepts, tools, modes, phases, or view-specific concepts such as floorplan or paint preview.
+ ## When making architecture-sensitive changes
- `packages/viewer` owns the standalone 3D canvas, renderers, viewer systems, and genuine presentation state. It must not know about `useEditor`, editor tools, phases, modes, paint mode, floorplan state, or editor-only presentation vocabulary.
+ Read the relevant page in `wiki/architecture/` **before** writing code. The page list lives in `wiki/architecture/README.md`. As a minimum:
- `apps/editor` owns the editing experience: tools, `useEditor`, panels, floorplan helpers, paint mode, keyboard shortcuts, command palette, action menus, cursor badges, and editor-only overlays. Editor features are injected into `<Viewer>` via props and children.
+ - Adding a node type → `node-schemas.md`, `renderers.md`, `systems.md`
+ - Adding a tool → `tools.md`, `spatial-queries.md`, `events.md`
+ - Adding a system → `systems.md`, `scene-registry.md`
+ - Anything in `packages/viewer` → `viewer-isolation.md`, `layers.md`
+ - Anything touching selection → `selection-managers.md`, `scene-registry.md`, `events.md`
- ## Review Expectations
+ ## When reviewing a PR
- When reviewing architecture changes:
+ Invoke the `review-architecture` skill (`.agents/skills/review-architecture/SKILL.md`). It loads the required architecture pages, fetches the diff, classifies each new file by layer, and reports findings grouped by severity.
- 1. Classify every new file, type, store field, and exported helper as core, viewer, or editor before writing findings.
- 2. Lead with layer-boundary blockers.
- 3. Check hook hygiene for `useEditor`, `useScene`, and `useViewer`.
- 4. Check selector performance for broad subscriptions and selectors that allocate fresh references.
- 5. Skip formatting and import ordering unless they hide a real behavior or architecture issue.
+ ## Operating rules
- Use `.codex/skills/review-architecture/SKILL.md` when the user asks Codex to review a PR, audit a branch, or check architecture compliance.
+ - Read the full file before editing. Plan all changes, then make one complete edit.
+ - When the user corrects you, stop and re-read their message.
+ - After two consecutive tool failures, stop and change approach.
+ - Don't introduce backwards-compatibility shims, dead code, or speculative abstractions.
+ - Don't write new comments unless they explain a non-obvious *why*.