Skip to content

docs: list every scaffolded file in the getting-started project trees - #3580

Merged
kojiwakayama merged 3 commits into
mainfrom
fix/dx-20260811-b2-23
Aug 11, 2026
Merged

kojiwakayama merged 3 commits into
mainfrom
fix/dx-20260811-b2-23

Conversation

@kojiwakayama

@kojiwakayama kojiwakayama commented Aug 11, 2026 •

Copy link
Copy Markdown
Contributor

Found during a DX dogfood walk of the published getting-started flow.

Symptom

The project trees in docs/getting-started/quickstart.md and
docs/getting-started/create-project.md are drawn as complete directory
listings: 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:

veryfront init my-agent --template ai-agent --skip-install --skip-env-prompt
find . -type f -not -path './node_modules/*' ! -name package-lock.json | sort

gives 14 files:

.gitignore  AGENTS.md  README.md  agents/assistant.ts  app/api/ag-ui/route.ts
app/layout.tsx  app/markdown-renderer.tsx  app/page.tsx  evals/assistant.eval.ts
globals.css  package.json  public/favicon.svg  tools/calculator.ts  tsconfig.json

The quickstart tree listed 5 of those 14. The create-project.md ai-agent tree
listed 6 of 14 while re-listing AGENTS.md, app/layout.tsx and app/page.tsx,
so it read as a full tree rather than a delta, yet dropped package.json and
README.md that the minimal tree just above it does list. The minimal tree
listed 6 of the 8 files that template writes (missing .gitignore and
public/favicon.svg).

The worst omission is evals/assistant.eval.ts: veryfront eval --list in the
scaffold prints - eval:assistant (agent:assistant), package.json ships an
"eval": "veryfront eval" script, and there is a whole guides/evals.md page,
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.json plus the
files the init flow generates for every template (.gitignore, AGENTS.md,
package.json). Reword The ai-agent template also creates: to
The ai-agent template creates:, since it is a full tree, not a delta. Mention
evals/ 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 docs
contracts in tests/docs/ (guide-contracts, guide-content,
cli-install-commands), which is where assertions about published prose already
live. It parses each documented ASCII tree out of the page and compares the file
set to cli/templates/manifest.json plus the always-generated files, so the next
template 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 init scaffold produced by this branch's CLI: all three
match the on-disk file set exactly.

deno task docs:validate validators (validate-guides, validate-public-docs,
check-doc-links) pass. The one failure in tests/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

    • Updated project setup and quickstart guides with accurate scaffold file trees.
    • Documented additional template files, including project guides, evaluations, assets, configuration, and markdown support.
    • Clarified that the template includes a smoke evaluation and project guidance.
  • Tests

    • Added coverage to verify documented scaffold trees stay synchronized with generated template files.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026 •

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@kojiwakayama, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 20 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bf53f88e-4f08-41bd-a865-948f00735552

📥 Commits

Reviewing files that changed from the base of the PR and between e3b4d57 and e087dcd.

📒 Files selected for processing (1)
  • docs/getting-started/create-project.md
📝 Walkthrough

Walkthrough

The PR updates scaffold trees in the getting-started documentation and adds contract tests that compare documented paths with template manifests and generated files.

Changes

Scaffold documentation parity

Layer / File(s) Summary
Document scaffold trees
docs/getting-started/create-project.md, docs/getting-started/quickstart.md
The documentation lists current template files, including guides, evals, assets, configuration, markdown rendering, styles, and types.
Validate scaffold parity
tests/docs/scaffold-trees.test.ts
New tests parse the documented trees and assert exact path equality with template manifests and generated files.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

Suggested reviewers: kwakayama

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting every scaffolded file in the getting-started project trees.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/dx-20260811-b2-23

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread tests/docs/scaffold-trees.test.ts
@kojiwakayama
kojiwakayama force-pushed the fix/dx-20260811-b2-23 branch from 5a2e2d7 to 05a710f Compare August 11, 2026 10:15
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 11, 2026
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 11, 2026
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 11, 2026
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 11, 2026
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 11, 2026
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Aug 11, 2026
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.
@kojiwakayama
kojiwakayama force-pushed the fix/dx-20260811-b2-23 branch from 05a710f to e3b4d57 Compare August 11, 2026 18:11

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 07683f1 and e3b4d57.

📒 Files selected for processing (3)
  • docs/getting-started/create-project.md
  • docs/getting-started/quickstart.md
  • tests/docs/scaffold-trees.test.ts

Comment thread docs/getting-started/create-project.md Outdated
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.
@kojiwakayama
kojiwakayama added this pull request to the merge queue Aug 11, 2026
Merged via the queue into main with commit 3e76121 Aug 11, 2026
33 checks passed
@kojiwakayama
kojiwakayama deleted the fix/dx-20260811-b2-23 branch August 11, 2026 18:42
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.

1 participant