Skip to content

docs: restore the concrete type list in the scaffold AGENTS.md - #1635

Merged
vivek7405 merged 1 commit into
mainfrom
docs/restore-type-list-agents-md
Oct 8, 2026
Merged

vivek7405 merged 1 commit into
mainfrom
docs/restore-type-list-agents-md

Conversation

@vivek7405

@vivek7405 vivek7405 commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #1634

Restores a short, concrete list of typing forms under "Type everything" in the scaffold AGENTS.md. #1632 had reduced the section to a pointer, and typing is the one rule webjs check and tsc cannot enforce, so the forms an agent should reach for now sit in the file it reads first. The rule itself stays canonical in the skill's Default Workflow step 8.

What changed

  • packages/cli/templates/AGENTS.md: four bullets (row type via $inferSelect, action input and ActionResult<T>, routing props plus npx webjsdev types, prop<T>()). About 560 characters, well under the roughly 1k the issue allowed, and it does not restate the unknown rule from step 8.

Docs surfaces

  • Skill and references: N/A, they already carry the full ladder.
  • website/app/docs/ai-first/page.ts: N/A, it only has a generic one-line "Type everything" tip.
  • MCP, editor plugins, marketing copy, Bun parity: N/A, no code or runtime surface changed.

Test plan

  • Scaffold template validation: same two failures as on unmodified main (a ws import error in this environment), nothing new.
  • Scaffolding the full-stack and api templates through scaffoldApp generates the section with the four bullets (checked in the generated AGENTS.md; the CLI entry point itself fails to start in this environment on the same ws import error as main).
  • Full Node, browser, e2e and Bun suites: N/A, a markdown template changed and no code path did.

#1632 reduced the "Type everything" section to a pointer. Typing is the
one rule check and tsc cannot enforce, so the concrete forms belong where
an agent reads first: the row type, action input and result, routing
props, the typed Route union and prop<T>(). The rule itself stays in the
skill's Default Workflow step 8.
@vivek7405 vivek7405 self-assigned this Oct 8, 2026
@pilots-run

pilots-run Bot commented Oct 8, 2026

Copy link
Copy Markdown

Preview for 3263179 was not built: compose file has unsupported keys

Next: fix the listed keys in the compose file

@vivek7405
vivek7405 marked this pull request as ready for review October 8, 2026 14:05
@vivek7405
vivek7405 merged commit 5f02040 into main Oct 8, 2026
10 of 11 checks passed
@vivek7405
vivek7405 deleted the docs/restore-type-list-agents-md branch October 8, 2026 15:56
vivek7405 pushed a commit that referenced this pull request Oct 8, 2026
Restores every rule #1632 collapsed into a pointer, in AGENTS.md,
CONVENTIONS.md, workflow.md, CLAUDE.md, both playbooks and the skill,
including the design-token bullet in workflow.md. The saving was about
1,500 tokens per build, small next to a visible drop in how apps look.
The partial type-list restore from #1635 is replaced by the original
text.
vivek7405 added a commit that referenced this pull request Oct 8, 2026
Restores every rule #1632 collapsed into a pointer, in AGENTS.md,
CONVENTIONS.md, workflow.md, CLAUDE.md, both playbooks and the skill,
including the design-token bullet in workflow.md. The saving was about
1,500 tokens per build, small next to a visible drop in how apps look.
The partial type-list restore from #1635 is replaced by the original
text.

Co-authored-by: t <t@t>
vivek7405 pushed a commit that referenced this pull request Oct 8, 2026
Reverts #1637. The agent docs return to the state after #1632 and #1635:
each rule stated once and pointed to, with the concrete type list in the
scaffold AGENTS.md.
vivek7405 added a commit that referenced this pull request Oct 8, 2026
Reverts #1637. The agent docs return to the state after #1632 and #1635:
each rule stated once and pointed to, with the concrete type list in the
scaffold AGENTS.md.

Co-authored-by: t <t@t>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: restore the concrete type list in the scaffold AGENTS.md

1 participant