Update key concepts docs - #2711
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
|
9d58d60 to
3b7217f
Compare
3b7217f to
7921751
Compare
|
Per Claude:
|
…order benefits section
…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.
7921751 to
e79d9d9
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
The latest PR head remains a documentation-only rewrite with ten regenerated locales and a small Hindi translation correction. Most structural checks pass: MDX components, code/Mermaid fences, anchors, links, formatting, and the Core changeset are valid.
Key Findings
- 🟡 MEDIUM — The French four-area checklist reverses the source contract, stating that a UI feature without a corresponding action is invisible to users. The source says a feature with only actions is invisible to users; the French wording should be corrected.
- ⚪ LOW — The rewritten Related building blocks section drops the existing Data Programs documentation link from the English and locale pages, reducing navigation coverage.
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).
* docs: update key concepts * docs: fix mermaid node label syntax in key concepts action diagram * docs: revert three layers to a table, clarify architecture copy * docs: connect building-blocks table to file tree, clarify turn, use lists not cards * docs: add missing context, drop remaining cards, remove em dashes, reorder benefits section * docs: reformat what agent native includes as a table instead of a list * docs: remove remaining questions, make copy declarative * docs: define 'contract' on first use * docs: translate rewritten key concepts page into all 10 locales * docs: remove stray </content> tags, fix mdx formatting * docs: translate remaining English strings left in localized key-concepts 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.

Rework the Key Concepts doc for clarity, and translate into all 10 locales
Substantially edits
key-concepts.mdxfor 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:
Cardsgrid); converted "Five rules," "The four-area checklist," "Why not call an LLM inline," "Frames," and "Related building blocks" away fromCards/questions into plain lists, bold-headed sections, or tables, sinceCardshad become overused for content that isn't a navigation griddb-schema/db-query/useDbSynccode samples actually do, how the building-blocks table maps to the file tree above it, and a definition for "contract" on its first useTranslations:
ar-SA,de-DE,es-ES,fr-FR,hi-IN,ja-JP,ko-KR,pt-BR,zh-CN,zh-TWfrom scratch against the new English source'navigation'string literal in Korean, translatedview-screen/navigateidentifiers in Traditional Chinese that should have stayed untranslated)Includes a changeset (
@agent-native/core: patch).