docs: sanitize docusaurus sidebar labels; localize navbar for ja/fr by softmarshmallow · Pull Request #679 · gridaco/grida

softmarshmallow · 2026-04-22T10:30:37Z

Summary

Replace raw filename / "README" sidebar labels across the docusaurus docs with human-friendly ones (e.g. canvas-languages-and-fonts → Languages & fonts, feat-text-editing → Text Editing, feat-hash-nch → Fast Hashing).
Turn the "README" entry under Editor → Features into a proper category index page with a grouped table of contents.
Add _category_.json across 32 directories (wg/feat-*, wg/research/*, wg/format, wg/platform, editor/features, editor/shortcuts, design/vector-network, with-figma/*, platform/{customers,tags,west}, packages/@grida/*).
Localize the docusaurus chrome for Japanese and French: new i18n/ja/ and i18n/fr/ trees with navbar.json, footer.json, code.json. Extend i18n/ko/navbar.json with missing Platform and Packages items.
Misc quality: delete empty docs/cli/reference.md; fix typo and mismatched heading/alt text in right-inspector-panel-show-hide.md; update docs/index.md and translation peers to point at the renamed features/index.md.

What the user sees now

English sidebar (sample):

Editor
├── Features               ← was "README" / raw dirname
│   ├── Overview
│   ├── Add a property     ← was "property-add-new"
│   ├── Reorder properties ← was "property-re-order"
│   └── Show & hide inspector
├── Languages & fonts      ← was "canvas-languages-and-fonts"
└── Keyboard shortcuts     ← was "shortcuts"

Working Group
├── 2D Rendering           ← was "feat-2d"
├── Fast Hashing           ← was "feat-hash-nch"
├── Text Editing           ← was "feat-text-editing"
└── ...

Japanese / French navbar now reads ドキュメント / リファレンス / ワーキンググループ / ... and Documentation / Référence / Groupe de travail / ... instead of English fallback.

Test plan

pnpm turbo build --filter=docs — all 4 locales build successfully
Inspected generated HTML for editor/features and wg/ — labels resolve as expected (no "README", no raw kebab slugs in sidebar)
just fmt
Manual visual check of sidebar/navbar after preview deploy
Spot-check ja/fr locales render translated navbar/footer

Out of scope

Pre-existing broken markdown links inside docs/translations/{ja,fr,ko}/index.md and with-figma/index.md reference peer files that aren't translated — they surface as build warnings. These predate this PR and are best handled in a follow-up that switches those to URL-style links.

Summary by CodeRabbit

New Features
- Added French, Japanese, and Korean language translations for documentation UI and navigation elements.
Documentation
- Restructured editor features documentation with improved organization.
- Updated documentation page metadata and navigation hierarchy for better discoverability.
- Reorganized product documentation categories and sidebar structure.

@grida

Clean up user-facing sidebar labels across the docusaurus docs site: - Replace editor/features/README.md with an index.md (had been rendering as "README" in the sidebar) and add a grouped table of contents - Add title + sidebar_label frontmatter to previously unfrontmattered files whose sidebar entry was falling back to the raw filename (canvas-languages-and-fonts, property-*, right-inspector-*, blend-mode, 10-text-field, ko blend-mode translation) - Add _category_.json across wg/feat-*, wg/research/*, editor/features, editor/shortcuts, design/vector-network, with-figma/*, platform/*, and packages/@grida* so categories show human-friendly labels (e.g. "2D Rendering", "Fast Hashing", "Text Editing", "Keyboard shortcuts") Extend i18n: - Add i18n/ja and i18n/fr with navbar.json, footer.json, and code.json so Japanese and French navbars/footers/theme strings are localized (previously only Korean was covered) - Add Platform and Packages navbar items to i18n/ko/navbar.json Misc quality: - Delete empty docs/cli/reference.md - Fix typo and mismatched heading/alt text in right-inspector-panel-show-hide.md - Update docs/index.md and translation peers to point at the renamed features/index.md

vercel · 2026-04-22T10:30:43Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
blog	Ready	Preview, Comment	Apr 22, 2026 10:35am
docs	Ready	Preview, Comment	Apr 22, 2026 10:35am
grida	Ready	Preview, Comment	Apr 22, 2026 10:35am
viewer	Ready	Preview, Comment	Apr 22, 2026 10:35am

3 Skipped Deployments

Project	Deployment	Actions	Updated (UTC)
backgrounds	Ignored	Preview	Apr 22, 2026 10:35am
code	Ignored		Apr 22, 2026 10:35am
legacy	Ignored		Apr 22, 2026 10:35am

coderabbitai · 2026-04-22T10:31:09Z

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR adds French and Japanese internationalization translations for the documentation site, along with Korean navbar label updates. It restructures the editor features documentation by replacing README.md with index.md, introduces documentation category configuration files across feature and platform areas, and adds metadata frontmatter to documentation pages while updating navigation links accordingly.

Changes

Cohort / File(s)	Summary
French i18n translations `apps/docs/i18n/fr/code.json`, `apps/docs/i18n/fr/docusaurus-theme-classic/footer.json`, `apps/docs/i18n/fr/docusaurus-theme-classic/navbar.json`	Added 27 UI element translations for French locale, including error pages, accessibility labels, navigation controls, and footer/navbar items.
Japanese i18n translations `apps/docs/i18n/ja/code.json`, `apps/docs/i18n/ja/docusaurus-theme-classic/footer.json`, `apps/docs/i18n/ja/docusaurus-theme-classic/navbar.json`	Added 27 UI element translations for Japanese locale with same coverage as French translations.
Korean i18n updates `apps/docs/i18n/ko/docusaurus-theme-classic/navbar.json`	Added three missing navbar labels: Platform, Packages, and Sign In.
Design documentation metadata `docs/design/10-text-field.md`, `docs/design/blend-mode.md`, `docs/design/translations/ko/blend-mode.md`, `docs/design/vector-network/_category_.json`	Added YAML frontmatter (title, sidebar label, description) and restructured heading hierarchy; added category configuration for vector network section.
Editor features restructuring `docs/editor/features/README.md`, `docs/editor/features/index.md`, `docs/editor/features/_category_.json`, `docs/editor/features/property-*.md`, `docs/editor/shortcuts/_category_.json`, `docs/editor/canvas-languages-and-fonts.md`	Consolidated features documentation under new index.md entry point, removed README content list, added feature page metadata, created category definitions.
Documentation category definitions `docs/packages/@grida/`, `docs/platform/`, `docs/wg/`, `docs/with-figma/` (40+ `_category_.json` files)	Added category metadata and navigation links for documentation sections across packages, platform, working groups, and Figma integration areas.
Navigation link updates `docs/index.md`, `docs/translations/*/index.md`	Updated Editor documentation links from `./editor/features/README.md` to `./editor/features/index.md` across English, French, Japanese, and Korean language versions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Docusaurus platform docs sidebar #548: Adds Platform and Packages sidebar/navbar entries and related documentation category structures that align with this PR's documentation organization updates.
Copy-Paste from Figma #457: Modifies docs/editor/features area with related documentation link and content restructuring.
docs: restructure docs IA and landing pages #668: Updates documentation translation/index files and i18n assets similar to this PR's language version updates.

Suggested labels

documentation

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main changes: adding human-friendly sidebar labels via category files and localizing the navbar for Japanese and French.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch feature/hopeful-bell-2b3e6c

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

vercel Bot deployed to Preview – docs April 22, 2026 10:32 View deployment

vercel Bot deployed to Preview – blog April 22, 2026 10:32 View deployment

vercel Bot deployed to Preview – viewer April 22, 2026 10:33 View deployment

vercel Bot deployed to Preview – grida April 22, 2026 10:35 View deployment

softmarshmallow merged commit 37ec479 into main Apr 22, 2026
13 of 14 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: sanitize docusaurus sidebar labels; localize navbar for ja/fr#679

docs: sanitize docusaurus sidebar labels; localize navbar for ja/fr#679
softmarshmallow merged 1 commit intomainfrom
feature/hopeful-bell-2b3e6c

softmarshmallow commented Apr 22, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Apr 22, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 22, 2026 •

edited

Loading

Review failed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

softmarshmallow commented Apr 22, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What the user sees now

Test plan

Out of scope

Summary by CodeRabbit

Uh oh!

vercel Bot commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Apr 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

softmarshmallow commented Apr 22, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Apr 22, 2026 •

edited

Loading

coderabbitai Bot commented Apr 22, 2026 •

edited

Loading