Split Getting Started into a focused four-page series - #2553
Split Getting Started into a focused four-page series#2553kapunahelewong wants to merge 8 commits into
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Here's a visual recap of what changed: Open the full interactive recap |
There was a problem hiding this comment.
Builder reviewed your changes and found 1 potential issue 🔴
Review Details
Code Review Summary
PR #2553 splits the monolithic Getting Started guide into three continuation pages, adds nested documentation navigation, introduces the <Steps> overview and <Cards> follow-ups, and updates heading extraction to ignore MDX component contents. The overall information architecture is sound, and the new pages consistently carry the action → SQL → page progression. Risk assessment: Low (documentation and docs-UI changes).
Key Findings
- 🔴 HIGH — The SQL page links to
/docs/storing-data, but no such documentation page exists, so users following that reference reach a 404. - 🟡 MEDIUM — The new continuation links are shown in every localized sidebar even though the new pages have no localized files; locale-prefixed direct requests can fail instead of falling back to English.
- 🟡 MEDIUM — Lowering the code-block default leaves the existing renderer test asserting the old 30-line behavior, so the docs test suite currently fails.
The MDX page split and English navigation labels are internally consistent. 🧪 Browser testing: Will run after this review (PR touches UI code).
| Build a React route that displays your saved analyses and wire it into the | ||
| sidebar. Next in the series. | ||
|
|
||
| ### [Storing Data](/docs/storing-data) |
There was a problem hiding this comment.
🔴 Fix the broken Storing Data reference
The new SQL page links to /docs/storing-data, but there is no storing-data.mdx route in the docs corpus. Clicking this card sends readers to a 404; link to the existing database reference (or another valid SQL guide) instead.
Additional Info
Confirmed by searching packages/core/docs/content for the target slug; only this new link matched.
|
We've been automatically notified and are looking into it. Push a new commit to re-trigger the review, or contact support@builder.io if this keeps happening. Error ID: |
- getting-started: steps 1-2 only (create app + connect AI) - getting-started-actions: steps 3-4 (action + inline rendering) - getting-started-database: step 5 (SQL persistence) - getting-started-pages: steps 6-7 (page + navigation) - Nav gets Getting Started as parent with three children - i18n keys + baselines updated for all locales Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add Steps series-overview block to getting-started page 1 - Convert blockquote tips to Callout components (info + warning) - Replace What's next bullet list with Cards - Remove step numbers (3–7) from headings on pages 2–4 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Lower DEFAULT_CODE_MAX_LINES from 30 to 17 - Skip headings inside MDX block components (Cards, Steps, Comparison, etc.) in extractHeadings so card titles don't appear in the right-side TOC Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The three new getting-started docs pushed index build time past the default 5000ms on two tests that were missing an explicit timeout. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Single-line self-closing tags (<Foo ... />) no longer enter block mode. Standalone /> lines (end of multi-line self-closing) now clear block mode. Regression test added using recurring-jobs.mdx / ## Frontmatter. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
The |
66e3476 to
87b8c57
Compare
There was a problem hiding this comment.
Builder reviewed your changes and has a few items to flag 🟡
Review Details
Incremental Code Review Summary
I reviewed the latest PR #2553 head and the incremental changes since the prior review. No new actionable issues were found. The MDX heading-parsing change is covered by its regression test, the updated MarkdownRenderer expectation matches the 17-line default, the navigation/i18n updates remain consistent, and the changeset metadata is valid. Targeted docs tests pass (123 tests reported by the reviewers).
The existing /docs/storing-data broken-link comment remains unresolved and was intentionally not reposted, per the incremental-review instructions. Risk assessment: Low. 🧪 Browser testing: No new browser verification was run; prior visual verification was blocked by unavailable browser automation tooling.

Split Getting Started into a focused four-page series
The Getting Started page was a single long document covering everything from scaffolding to SQL to navigation. This PR splits it into four short, focused pages so readers can stop at any point with a working app.
By breaking up the Getting Started, we now have one, brief page that gets you started, with the rest of the steps being optional.
Structure
Each follow-on page links to the next, and the nav shows Getting Started as a parent with the three continuation pages as children.
Visual improvements to page 1
Other