Skip to content

Split Getting Started into a focused four-page series - #2553

Open
kapunahelewong wants to merge 8 commits into
BuilderIO:mainfrom
kapunahelewong:quick-get-started
Open

Split Getting Started into a focused four-page series#2553
kapunahelewong wants to merge 8 commits into
BuilderIO:mainfrom
kapunahelewong:quick-get-started

Conversation

@kapunahelewong

@kapunahelewong kapunahelewong commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

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

  • Getting Started — steps 1–2 only: scaffold the Chat template and connect an AI engine. Enough to have a working app.
  • Add an Action — define a typed action and render its result inline in chat.
  • Persist Data in SQL — wire up a database plugin, define a schema, and add read/write actions.
  • Add a Page — build a React route and extend the sidebar navigation.

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

  • Added a Steps overview block showing the full four-part series (with "You are here" on step 1)
  • Converted blockquote tips to Callout components
  • Replaced the "What's next" bullet list with Cards

Other

  • Removed step numbers (3–7) from headings on pages 2–4 — they're redundant now that each page has its own focus
  • Added i18n keys for the three new nav labels across all locales; baselines updated

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Here's a visual recap of what changed:

Visual recap

Open the full interactive recap

@builder-io-integration builder-io-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔴 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.

Fix in Builder

builder-io-integration[bot]

This comment was marked as outdated.

builder-io-integration[bot]

This comment was marked as outdated.

@builder-io-integration

Copy link
Copy Markdown
Contributor

⚠️ Review Agent ran into a problem and couldn't finish reviewing the latest commit.

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: deb024f49adb45cd881f3f897cd99534

builder-io-integration[bot]

This comment was marked as outdated.

kapunahelewong and others added 8 commits July 31, 2026 10:53
- 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>
@kapunahelewong

Copy link
Copy Markdown
Contributor Author

The guided-questions.flow.spec.tsx failure is a pre-existing flaky test unrelated to this PR which only touches packages/docs and packages/core/docs/content. The same test suite on main also has failing checks right now (trusted acceptance substrate, audit hosted app health), suggesting current CI issues. This isn't a regression this PR introduced.

@builder-io-integration builder-io-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

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