Skip to content

docs: rewrite getting started guide with hands-on fixes#2379

Open
kapunahelewong wants to merge 4 commits into
BuilderIO:mainfrom
kapunahelewong:docs/getting-started-onboarding-fixes
Open

docs: rewrite getting started guide with hands-on fixes#2379
kapunahelewong wants to merge 4 commits into
BuilderIO:mainfrom
kapunahelewong:docs/getting-started-onboarding-fixes

Conversation

@kapunahelewong

Copy link
Copy Markdown

Rewrote the Getting Started guide end-to-end after following it as a
first-time user and documenting gaps, missing instruction, and
clarifying details.

Changes by section:

Section 1 (Create a chat app)

  • Added directory context before the create command
  • Added explanation of NitroViteError startup noise (harmless race condition)
  • Added instructions for the login screen (sign up with any credentials,
    no email verification required locally)
  • Moved the "different app types" note into a collapsible subsection

Section 2 (Connect an AI engine) — new section

  • The original doc skipped this entirely; a missing key causes a blank screen
    with no explanation
  • Added step-by-step for both connection options: Builder.io (one click)
    and manual API key entry
  • Added .env fallback with exact path and command
  • Added a callout explaining why a blank screen needs the env var fix
    rather than the in-app setup panel

Section 3 (Add an action)

  • Added a plain-language definition of what an action is
  • Added the existing hello action with instructions for running it from
    the terminal and from chat
  • Replaced the analyze-responses example (which conflicted with the Forms
    template in a connected workspace) with a self-contained analyze-text
    action that has no external dependencies
  • Added a tip on phrasing agent prompts to avoid A2A routing ambiguity

Section 4 (Render the result inline)

  • Added explanation of what chatUI.renderer does and why
  • Added the explicit root.tsx import line (was missing)
  • Fixed the bar chart renderer: replaced bg-primary (CSS variable that
    didn't resolve) with bg-blue-500, and replaced percentage heights
    (which collapsed in flex-col) with pixel heights via MAX_BAR_PX
  • Updated wireframe to match the analyze-text example

Section 5 (Persist data in SQL)

  • Added context explaining why persistence matters
  • Added the db plugin file (server/plugins/db.ts) — not included in the
    Chat template by default, its absence caused a TS error
  • Added schema file instructions including the server/db/ directory
    creation step
  • Replaced drizzle-orm ORM usage with getDbExec + raw SQL (drizzle-orm
    is not a direct dependency of the Chat template)
  • Added three action files: save-text-analysis, list-text-analyses,
    delete-text-analysis
  • Added terminal commands to verify the migration ran and test each action
  • Added expected output so readers know what success looks like

Section 6 (Add a page the agent can open)

  • Added context explaining why (visual home for SQL data, same state as agent)
  • Replaced response-insights example with text-analyses route using the
    actions built in section 5
  • Updated wireframe to match

Section 7 (Let the agent navigate) — renamed from "Add a page"

  • Removed duplicate "try it" prompt (already in section 6)
  • Reframed as explanation of the built-in view-screen and navigate actions
  • Added guidance on keeping navigation updated as the app grows

Throughout

  • Removed all em dashes
  • Fixed all remaining references to response-insights, analyze-responses,
    and Forms-specific examples

@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 24, 2026

Copy link
Copy Markdown
Contributor

Here's a visual recap of what changed:

Visual recap

Open the full interactive recap

builder-io-integration[bot]

This comment was marked as outdated.

@steve8708

Copy link
Copy Markdown
Contributor

this looks great - only thing missing is translations. english is updated, but we translate docs to ~10 other locales (point a coding agent at it and it can translate for you. they aren't perfect, obv are AI translated, but still people have shared appreciation for it)

the builder bot comment above looks like a good one too to make sure our snippet follows best practices

builder-io-integration[bot]

This comment was marked as outdated.

builder-io-integration[bot]

This comment was marked as outdated.

@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 — looks good ✅

Review Details

Incremental Code Review Summary

The latest commit updates the Traditional Chinese Getting Started localization and related catalog content. The updated guide preserves the expected seven-step structure, anchors, links, code fences, commands, action names, and route examples. Review agents also confirmed the i18n catalog guard and documentation validation/typecheck pass.

The previously reported unscoped text_analyses persistence issue remains open and is intentionally not resubmitted in this incremental review. No new confirmed functional documentation defects were found.

Risk level: Low.

🧪 Browser testing: Skipped — PR only modifies documentation and localization metadata, with no application UI or runtime behavior changes.

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.

2 participants