docs: audit English source + migrate i18n to zh-Hans and add ja/de/es/fr#9
Merged
Merged
Conversation
Documentation accuracy audit and internationalization overhaul for the
docs site. English is the single source of truth; all locales derive from it.
English audit (technical accuracy, consistency, completeness, links):
- Corrected API routes and signatures against the framework source
(~/Documents/GitHub/framework), not the generic skills:
- actions: Action.create usage; action route /api/v1/actions/<object>/<action>
- agents: ai_conversations object name, model object shape, memory shortTerm/longTerm
- data-model: Field.lookup signature
- flows: corrected action invocation path
- architecture: OS_ARTIFACT_PATH
- configure/ai, build/index (Console + Account), and others
- 24 English pages updated.
i18n migration (cn -> zh-Hans) and new locales:
- i18n config now serves en, zh-Hans, ja, de, es, fr (en default, hideLocale).
- Renamed 51 *.cn.mdx -> *.zh-Hans.mdx and 6 meta.cn.json -> meta.zh-Hans.json;
zh-Hans content resynced to the audited English.
- Added meta.{ja,de,es,fr}.json sidebar files.
- Fully translated all docs pages into ja/de/es/fr.
- middleware: map zh/zh-CN/zh-TW/... -> zh-Hans; permanent 308 redirect /cn/* -> /zh-Hans/*.
- layout / layout.shared / homepage-i18n / download-i18n: registry-based locale
lookup with English fallback; LANGUAGE_NAMES and nav labels for all 6 locales.
- privacy/terms legal pages fall back to English for new locales pending
professional legal translation.
Tooling:
- Added .claude/launch.json describing the docs, server, and Tauri dev servers.
Known follow-up: 1-2 German pages (reference/security, resources/glossary) hit
transient API errors during bulk translation and fall back to English until
re-run; homepage/download UI strings not yet translated into ja/de/es/fr.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Two Spanish translations replaced the English em-dash with a colon in the frontmatter description. An unquoted YAML scalar containing ': ' is parsed as a nested mapping, breaking the docs build (YAMLException: bad indentation of a mapping entry). Wrap both descriptions in double quotes. - content/docs/build/packages.es.mdx - content/docs/quickstart.es.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
Two related pieces of work on the docs site, delivered together:
1. English source audit
Reviewed every platform doc page for technical accuracy, writing/consistency, completeness, and links — editing the English source (the single source of truth). Corrections were verified against the framework source (
~/Documents/GitHub/framework), not the generic skills, which were sometimes wrong.Notable fixes (24 English pages):
Action.createusage; action route/api/v1/actions/<object>/<action>(verified againstdispatcher-plugin.ts)ai_conversationsobject name, model object shape, memoryshortTerm/longTermField.lookupsignatureOS_ARTIFACT_PATH2. i18n overhaul:
cn→zh-Hans+ 4 new localesThe Chinese locale used
cn(a region code, not a valid BCP 47 language tag). Migrated tozh-Hansand added ja, de, es, fr.en, zh-Hans, ja, de, es, fr(en default,hideLocale: 'default-locale')*.cn.mdx→*.zh-Hans.mdxand 6meta.cn.json→meta.zh-Hans.json; zh-Hans content resynced to the audited Englishmeta.{ja,de,es,fr}.jsonsidebar filesmiddleware.ts: normalizezh/zh-CN/zh-TW/… →zh-Hans; permanent 308 redirect/cn/*→/zh-Hans/*(preserves SEO)layout/layout.shared/homepage-i18n/download-i18n: registry-based locale lookup with English fallback;LANGUAGE_NAMESand nav labels for all 6 localesTooling
.claude/launch.jsondescribing the docs, ObjectStack server, and Tauri desktop dev servers.Reviewer notes
privacy,terms) intentionally fall back to English for the new locales — legal text should be professionally translated, not machine-translated.type-checkpasses for the localized files.Known follow-ups
reference/security,resources/glossary) hit transient API errors during bulk translation and currently fall back to English — need a re-run.