docs: add W4 runtime validation planning artifacts#3059
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds W4 documentation for introducing contracts-first runtime validation at the daemon HTTP boundary, plus a small gitignore tweak.
Changes:
- Added a W4 runtime validation design spec covering scope, rules, and error model for
/api/chatand/api/proxy/*/stream. - Added a detailed, step-by-step implementation plan (contracts schemas, daemon helper, and route-level tests).
- Updated
.gitignoreto ignore a local.worktrees/directory.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/superpowers/specs/2026-05-19-w4-runtime-validation-design.md | Defines the intended validation architecture, rules, and error envelope. |
| docs/superpowers/plans/2026-05-19-w4-runtime-validation-foundation.md | Provides the task checklist and example code/tests to implement the design. |
| .gitignore | Ignores .worktrees/ directory artifacts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `apiKey`: non-empty string, except only existing route behavior may decide defaults elsewhere | ||
| - `apiKey`: non-empty string |
| git -C G:\AUDHOUSE\HOUSEDRAW\open-design add -- packages/contracts/src/api/comments.ts packages/contracts/src/api/chat.ts packages/contracts/src/index.ts packages/contracts/tests/api-validation.test.ts | ||
| git -C G:\AUDHOUSE\HOUSEDRAW\open-design commit -m "feat(contracts): add chat request schemas" |
|
|
||
| ```ts | ||
| import { z } from 'zod'; | ||
| import type { OkResponse } from '../common'; |
| import type { ProjectFile } from './files'; | ||
| import type { | ||
| PreviewCommentMember, | ||
| PreviewCommentPosition, | ||
| PreviewCommentSelectionKind, | ||
| } from './comments'; |
lefarcen
left a comment
lefarcen
left a comment
There was a problem hiding this comment.
Hi @bestvcboy! Thanks for pulling the W4 runtime-validation docs together — keeping the design artifact and implementation plan side by side should make the eventual daemon-boundary work easier to follow.
One PR-body item before this goes through pool review: could you fill in the new template details for Why, What users will see, Surface area, and Validation? For this docs/planning PR, Surface area can likely mark the docs/design-planning path rather than any runtime UI/API change, and Validation should say what you checked beyond rebasing/pushing the branch.
Once that context is in the description, reviewers will have a much quicker time scoping the change. 🙌
Summary\n- add W4 runtime validation foundation plan\n- retain local runtime validation design/spec artifacts merged onto latest upstream main\n- preserve local .worktrees ignore handling without deleting content\n\n## Validation\n- local main merged with upstream main and pushed to bestvcboy/open-design:chore/w4-runtime-validation-design