Skip to content

chore: let Babelize format the translated docs - #99

Merged
sapatmohit merged 1 commit into
mainfrom
chore/format-translated-docs
Nov 1, 2026
Merged

sapatmohit merged 1 commit into
mainfrom
chore/format-translated-docs

Conversation

@sapatmohit

@sapatmohit sapatmohit commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

Babelize 1.0.17 formats translated docs with the project's own Prettier (babelize/babelize-dashboard#407), so the workaround from #98 isn't needed anymore.

  • .prettierignore no longer lists the generated *.{es,ja,ar}.mdx, meta.*.json and docs-lock.json.
  • I re-ran babelize translate --docs-only --to es,ja,ar with the published babelize@1.0.17. All 3,105 translations came from the lockfile, with 0 translated. The only change is formatting, in 52 pages: table padding and JSON arrays.
  • Lint, format:check, typecheck, tests, build, build:lib and test:pack all pass locally.

Summary by CodeRabbit

  • Documentation
    • Improved formatting and alignment across Arabic, Spanish, and Japanese documentation tables and examples.
    • No documented component behavior, values, or content changed.

Babelize 1.0.17 formats translated docs with the project's Prettier
(babelize/babelize-dashboard#407), so the generated pages no longer need
to be in .prettierignore. Re-ran babelize translate --docs-only: the
translations are unchanged (all from the lockfile); 52 pages were only
reformatted.
@coderabbitai

coderabbitai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 97e9f9af-777c-4f8e-a65b-b7d6be394705
Commits

Reviewing files that changed from the base of the PR and between 29a251f and ba2e746.

Files selected for processing: 53
  • .prettierignore
  • content/docs/components/index.ar.mdx
  • content/docs/components/index.es.mdx
  • content/docs/components/index.ja.mdx
  • content/docs/components/inputs/meta.ar.json
  • content/docs/components/inputs/meta.es.json
  • content/docs/components/inputs/meta.ja.json
  • content/docs/components/inputs/phone-input.ar.mdx
  • content/docs/components/inputs/phone-input.es.mdx
  • content/docs/components/inputs/phone-input.ja.mdx
  • content/docs/components/language-switchers/language-switcher-pill.ar.mdx
  • content/docs/components/language-switchers/language-switcher-pill.es.mdx
  • content/docs/components/language-switchers/language-switcher-pill.ja.mdx
  • content/docs/components/language-switchers/language-switcher.ar.mdx
  • content/docs/components/language-switchers/language-switcher.es.mdx
  • content/docs/components/language-switchers/language-switcher.ja.mdx
  • content/docs/components/language-switchers/meta.ar.json
  • content/docs/components/language-switchers/meta.es.json
  • content/docs/components/language-switchers/meta.ja.json
  • content/docs/components/locale-pickers/locale-picker.ar.mdx
  • content/docs/components/locale-pickers/locale-picker.es.mdx
  • content/docs/components/locale-pickers/locale-picker.ja.mdx
  • content/docs/components/locale-pickers/meta.ar.json
  • content/docs/components/locale-pickers/meta.es.json
  • content/docs/components/locale-pickers/meta.ja.json
  • content/docs/components/meta.ar.json
  • content/docs/components/meta.es.json
  • content/docs/components/meta.ja.json
  • content/docs/components/navigation/meta.ar.json
  • content/docs/components/navigation/meta.es.json
  • content/docs/components/navigation/meta.ja.json
  • content/docs/components/navigation/navbar.ar.mdx
  • content/docs/components/navigation/navbar.es.mdx
  • content/docs/components/navigation/navbar.ja.mdx
  • content/docs/components/translation/meta.ar.json
  • content/docs/components/translation/meta.es.json
  • content/docs/components/translation/meta.ja.json
  • content/docs/components/translation/translation-widget.ar.mdx
  • content/docs/components/translation/translation-widget.es.mdx
  • content/docs/components/translation/translation-widget.ja.mdx
  • content/docs/customization/meta.ar.json
  • content/docs/customization/meta.es.json
  • content/docs/customization/meta.ja.json
  • content/docs/getting-started/index.ar.mdx
  • content/docs/getting-started/install.ar.mdx
  • content/docs/getting-started/install.es.mdx
  • content/docs/getting-started/install.ja.mdx
  • content/docs/getting-started/meta.ar.json
  • content/docs/getting-started/meta.es.json
  • content/docs/getting-started/meta.ja.json
  • content/docs/getting-started/rulebook.ar.mdx
  • content/docs/getting-started/rulebook.es.mdx
  • content/docs/getting-started/rulebook.ja.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The pull request removes formatting exclusions for localized documentation and reformats Spanish, Japanese, and Arabic documentation and metadata. The documented component details, metadata values, and getting-started content remain unchanged.

Changes: Localized documentation formatting

Layer / File(s) Summary
Enable formatting for localized files
.prettierignore
Removes ignore patterns for translated documentation, localized metadata, and .babelize/local/docs-lock.json.
Component catalog and phone input
content/docs/components/index.*.mdx, content/docs/components/meta.*.json, content/docs/components/inputs/*
Reformats component index tables, phone-input documentation tables, and related metadata. Listed entries and documented values remain unchanged.
Language switchers and locale pickers
content/docs/components/language-switchers/*, content/docs/components/locale-pickers/*
Reformats localized tables and metadata. Documented properties, defaults, supported languages, and keyboard actions remain unchanged.
Navigation and translation
content/docs/components/navigation/*, content/docs/components/translation/*
Reformats localized tables and metadata. Documented properties, values, and behavior remain unchanged.
Getting-started documentation
content/docs/customization/meta.*.json, content/docs/getting-started/*
Reformats localized metadata, prerequisites tables, and JSX components. Values and content remain unchanged.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related issues

  • Issue 96 tracks Spanish, Japanese, and Arabic localization, including translated MDX documentation. This pull request reformats those localized files.

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: ujwalbajaj

Merge Risk: Minimal · up to ba2e7

No merge-blocking issue is identified. The changes enable formatting of localized documentation and normalize its layout without an established behavioral regression.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: allowing Babelize to format translated documentation.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (52 skipped: 52 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@sapatmohit
sapatmohit merged commit 8c45f23 into main Nov 1, 2026
2 checks passed
@sapatmohit
sapatmohit deleted the chore/format-translated-docs branch November 1, 2026 15:52
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.

1 participant