Skip to content

Update key concepts docs - #2711

Open
kapunahelewong wants to merge 11 commits into
BuilderIO:mainfrom
kapunahelewong:update-key-concepts-docs
Open

Update key concepts docs#2711
kapunahelewong wants to merge 11 commits into
BuilderIO:mainfrom
kapunahelewong:update-key-concepts-docs

Conversation

@kapunahelewong

Copy link
Copy Markdown
Contributor

Rework the Key Concepts doc for clarity, and translate into all 10 locales

Substantially edits key-concepts.mdx for clarity and readability, then brings all 10 locale translations up to date with the rewrite (they were untouched by this and had drifted out of sync).

Content changes:

  • Reverted "The three layers" back to a table (was briefly a Cards grid); converted "Five rules," "The four-area checklist," "Why not call an LLM inline," "Frames," and "Related building blocks" away from Cards/questions into plain lists, bold-headed sections, or tables, since Cards had become overused for content that isn't a navigation grid
  • Moved "What Agent Native includes" (renamed from "What you get for free") to sit right after the five rules it depends on, instead of after all the deep-dive sections, and reformatted its 11 bullets into a two-column table
  • Added missing context throughout: what the architecture diagram and action fan-out diagram are showing, what the Drizzle schema / db-schema / db-query / useDbSync code samples actually do, how the building-blocks table maps to the file tree above it, and a definition for "contract" on its first use
  • Removed every em dash and rhetorical question in the file, rewriting sentences to work without them
  • Fixed a real Mermaid syntax bug (parentheses in a node label broke the parser)

Translations:

  • Regenerated ar-SA, de-DE, es-ES, fr-FR, hi-IN, ja-JP, ko-KR, pt-BR, zh-CN, zh-TW from scratch against the new English source
  • Verified structurally identical to English: same 17 heading anchors, same component IDs, code blocks byte-for-byte identical including comments
  • Along the way, fixed a couple of pre-existing translation bugs unrelated to this rewrite (a mistranslated 'navigation' string literal in Korean, translated view-screen/navigate identifiers in Traditional Chinese that should have stayed untranslated)

Includes a changeset (@agent-native/core: patch).

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@netlify

This comment has been minimized.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Here's a visual recap of what changed:

Visual recap

Open the full interactive recap

Large diff — this recap is a summarized view (top files + schema/API deltas).

builder-io-integration[bot]

This comment was marked as outdated.

builder-io-integration[bot]

This comment was marked as outdated.

builder-io-integration[bot]

This comment was marked as outdated.

builder-io-integration[bot]

This comment was marked as outdated.

…pts pages

Fixes guard:i18n-catalogs — the rewritten key-concepts.mdx locale pages
carried several link titles, headings, a diagram, and a bash comment
verbatim from the English source instead of translating them:

- "Related docs" card titles (A2A Protocol, Agent Surfaces, Context
  Awareness, Native Chat UI, Skills Guide, What Is Agent-Native?) and
  their inline-link occurrences elsewhere in the page, now matching
  each linked page's own translated title.
- The German/Spanish/French/Hindi/Japanese/Korean/Portuguese/Chinese
  'Core actions for quick database inspection' bash comment.
- hi-IN-specific stragglers: the SQL-store table/diagram labels,
  'Agent action' / 'Change event' / 'Query refetch' diagram nodes, and
  the OAuth credentials / view-selection-drafts data model notes.
- hi-IN's agent-surfaces.mdx title/H1, which was still untranslated
  and blocked translating its own key-concepts.mdx backlink.
@kapunahelewong
kapunahelewong force-pushed the update-key-concepts-docs branch from 3b7217f to 7921751 Compare August 10, 2026 19:41

@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 PR head retains the Key Concepts rewrite, all ten locale translations, and the Hindi Agent Surfaces translation correction. The current diff remains sound: MDX components and fences are balanced, anchors and internal links are valid, locale structure is consistent, documentation validation and production checks pass, and the Core patch changeset is correctly formatted.

Review Result

  • ✅ No new clear documentation rendering, link, translation, code-example, formatting, or release issues found.
  • ✅ Previously reported unmatched tags and formatting failures remain fixed.
  • ✅ Agents report passing docs tests, block validation, link checks, and formatting checks.

Risk remains low because this PR changes documentation and a patch changeset only.

🧪 Browser testing: Will run after this review (PR touches rendered documentation/UI surfaces).

@kapunahelewong
kapunahelewong enabled auto-merge (squash) August 10, 2026 19:57
@kapunahelewong

Copy link
Copy Markdown
Contributor Author

Per Claude:
Only Fast tests lane-2 (and the Fast tests gate reflecting it) is still red, and I've now conclusively proven it's a pre-existing bug on main itself, not caused by our rebase or this PR:

  • A new test on main (packages/docs/server/plugins/agent-chat.spec.ts, added by the "Update shared framework apps and template flows" commit we just rebased onto) imports a codegen artifact (.generated/actions-registry.ts) that's only ever produced when Vite actually boots — vitest run alone never triggers it.
  • I confirmed this by checking out a completely clean worktree of upstream/main at its current tip, with no prior build/dev run, and running that spec file directly: same ERR_MODULE_NOT_FOUND error, 100% reproducible, nothing to do with our PR or the rebase.

So I think we can merge. Can you check my thinking, @steve8708?

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