Repository navigation
docs: split architecture into owner documents and tighten agent guidance - #9863
Open
joshistoast wants to merge 4 commits into
Open
joshistoast wants to merge 4 commits into
joshistoast wants to merge 4 commits into
Conversation
…guidance Split ARCHITECTURE.md into owner READMEs, fix stale ownership and path references, and add delegation, review, and performance-gate guidance. Add `pnpm dev:mock`, a shared stepped-drag test helper, and performance gate failures that name the fix. Run pnpm from package directories instead of `pnpm -C` from the root.
Compress AGENTS.md files, architecture docs, and owner READMEs into shorter sentences without dropping conditions. Correct the extensions README: nothing renders registered menu contributions yet.
The main agent plans, briefs, integrates, and validates; implementers make all repository edits so the main conversation keeps its context. Agents without subagent support edit locally.
Commit attribution is a personal preference, not a repository rule.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Agent guidance was long, partly stale, and routed every ownership change through a 56 KB architecture doc. This PR:
invokeai/frontend/webv2/ARCHITECTURE.md(56 KB → 18 KB) into owner READMEs, listed in a new "Owner documents" table, and adds shortAGENTS.mdpointers next to the Canvas, projects, and extensions docs.workbench/backendand migrated ownership rows, deleted test files cited by the Canvas doc, and paths with no stated root.invokeai/frontend/webv2/performance/README.md: what each performance gate checks, causes and fixes per failure message, byte-budget rules, and remediation tickets.AGENTS.mdfiles and owner specs into shorter sentences without dropping conditions; adds rules for delegation (every file edit goes through an implementation subagent), stable review candidates, shared-resource coordination, and repo guidance overriding external skill defaults.pnpm dev:mock(Vite against the in-repo mock backend on a free port), a shareddragWithMousetest helper for dnd-kit droppables enabled after drag start, and performance gate failures that name the counted specifier, the fix, and the guide.pnpm -C <package>from the root with running pnpm in the package directory (Corepack resolves pnpm per directory) in docs and two Makefile targets.QA Instructions
From
invokeai/frontend/webv2:pnpm lint: passed.pnpm test:browser src/features/gallery/ui/GalleryBoardsPanel.browser.test.tsx: 25/25 with the shared drag helper; a single-jump variant fails 3 drag tests.pnpm check:release:test:browserhad 2 failures under load (WorkbenchHotkeyRuntime.modal,WorkflowFieldInput), both untouched by this PR; each passed 81/81 twice when rerun alone. The remaining gates then ran and passed:test:fixtures,test:performance:architecture,test:project-files:browser,test:accessibility:browser.@platform/uiimporter budget temporarily lowered, the build gate reportsplatformUiBarrel has 160 direct importers of @platform/ui (budget 150), the subpath remedy, andCauses and fixes: invokeai/frontend/webv2/performance/README.md. A forced editor-runtime hit reports the same guide line.pnpm dev:mock --port 5373 --strictPort: page and proxied/apireturn 200; SIGTERM exits 143 and SIGKILL of Vite exits 137, releasing both ports.oxfmt --checkclean; every relative link resolves; every path resolves from each doc's stated root.The later doc-only commits ran formatting and link checks, not application suites.
Review
Resolved findings: wrong default Vite port (5174), editor-runtime failures missing the guide pointer, a Canvas doc sentence overstating the dependency rule, remaining
pnpm -Cdocs,dev:mockreporting exit 0 on signal death, and wording that changed meaning while tightening (authentication dropped from "auth", "modify" widened to "touch", lock-order example read as the full rule, requirements read as facts). The extensions README no longer claims header menus render menu contributions; nothing reads registered menus yet.Checklist
What's Newcopy (if doing a release after this PR)Need help on this PR? Tag
@codesmith-botwith what you need.