docs: list every scaffolded file in the getting-started project trees - #3580
Conversation
|
Warning Review limit reached
Next review available in: 20 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe PR updates scaffold trees in the getting-started documentation and adds contract tests that compare documented paths with template manifests and generated files. ChangesScaffold documentation parity
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5a2e2d736f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
5a2e2d7 to
05a710f
Compare
The quickstart and create-project trees are drawn as complete listings with no ellipsis, but the ai-agent tree showed 5 of the 14 files `veryfront init` actually writes and the minimal tree showed 6 of 8. Readers who go looking for `evals/`, `globals.css`, or `tsconfig.json` conclude they are missing. Complete both trees from the template manifest and add a contract test that parses the documented trees and compares them to `cli/templates/manifest.json` plus the files the init flow always generates.
… trees The documented trees were written before globals.d.ts was added to the styled starters (#3568) and before the minimal template shipped a tsconfig.json, so scaffold-trees.test.ts passed on this branch but failed once merged with main. The merge queue caught it; the trees now match the templates again.
05a710f to
e3b4d57
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/getting-started/create-project.md`:
- Line 129: Update the fenced code block in the getting-started documentation to
specify the text language by changing its opening fence to use the text
identifier, eliminating the MD040 warning.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro Plus
Run ID: daa774a9-1666-4ca4-8b29-395c00d631b4
📒 Files selected for processing (3)
docs/getting-started/create-project.mddocs/getting-started/quickstart.mdtests/docs/scaffold-trees.test.ts
Both tree blocks were bare while every other fence in the file is typed (line 23 is already ```text), so MD040 fired on them. Typing both rather than only the flagged one keeps the two sibling trees consistent.
Found during a DX dogfood walk of the published getting-started flow.
Symptom
The project trees in
docs/getting-started/quickstart.mdanddocs/getting-started/create-project.mdare drawn as complete directorylistings: a project root, nested directories, no ellipsis and no "partial"
marker. They are not complete.
Scaffolding with the literal documented command and enumerating the result:
gives 14 files:
The quickstart tree listed 5 of those 14. The
create-project.mdai-agent treelisted 6 of 14 while re-listing
AGENTS.md,app/layout.tsxandapp/page.tsx,so it read as a full tree rather than a delta, yet dropped
package.jsonandREADME.mdthat the minimal tree just above it does list. The minimal treelisted 6 of the 8 files that template writes (missing
.gitignoreandpublic/favicon.svg).The worst omission is
evals/assistant.eval.ts:veryfront eval --listin thescaffold prints
- eval:assistant (agent:assistant),package.jsonships an"eval": "veryfront eval"script, and there is a wholeguides/evals.mdpage,but nothing in getting-started tells a reader the directory exists.
Root cause
The trees were hand-maintained prose. Templates gained files (
evals/,markdown-renderer.tsx,globals.css,tsconfig.json,public/favicon.svg)and nothing tied the documentation back to what the templates ship, so the trees
drifted silently.
Fix
Complete all three trees so they match
cli/templates/manifest.jsonplus thefiles the init flow generates for every template (
.gitignore,AGENTS.md,package.json). RewordThe ai-agent template also creates:toThe ai-agent template creates:, since it is a full tree, not a delta. Mentionevals/in the prose beneath and link the evals guide from the quickstart.Regression test
tests/docs/scaffold-trees.test.ts(new). It lives beside the other docscontracts in
tests/docs/(guide-contracts,guide-content,cli-install-commands), which is where assertions about published prose alreadylive. It parses each documented ASCII tree out of the page and compares the file
set to
cli/templates/manifest.jsonplus the always-generated files, so the nexttemplate file that lands fails the build instead of quietly aging the docs out of
date.
Confirmed failing before the fix for the right reason (diff showed exactly the
nine and two missing paths), passing after. The corrected trees were also diffed
against a real
veryfront initscaffold produced by this branch's CLI: all threematch the on-disk file set exactly.
deno task docs:validatevalidators (validate-guides,validate-public-docs,check-doc-links) pass. The one failure intests/docs/locally(
guide-examples.test.ts"runs.mdx") is a sandbox network refusal(
General SOCKS server failure) unrelated to this change.Summary by CodeRabbit
Documentation
Tests