Skip to content

docs(contributing): document i18n locale field rendering types#656

Merged
castrojo merged 1 commit into
mainfrom
docs/i18n-field-rendering-648
Jun 5, 2026
Merged

docs(contributing): document i18n locale field rendering types#656
castrojo merged 1 commit into
mainfrom
docs/i18n-field-rendering-648

Conversation

@hanthor
Copy link
Copy Markdown
Member

@hanthor hanthor commented May 29, 2026

Summary

Translators have no way to know which locale keys support Markdown, which accept raw HTML, and which are plain text only. Using the wrong markup produces literal asterisks or tags in the rendered page.

Adds a Locale field rendering subsection under the i18n instructions in CONTRIBUTING.md with three tables:

  • 24 Markdown fields (rendered via marked.parse())
  • 2 raw HTML fields (Bazaar.Description, Bazaar.Additional — rendered via v-html)
  • Plain text note for all remaining keys

Closes #648

Test plan

  • CONTRIBUTING.md renders correctly in GitHub preview
  • Verify tables match current component source (spot-check SceneUsers.vue, SectionBazaar.vue, SectionFooter.vue)

🤖 Generated with Claude Code

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

Warning

Review limit reached

@castrojo, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 34 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 01a2dbaf-d8d9-4958-8444-ff9f883bccd1

📥 Commits

Reviewing files that changed from the base of the PR and between e327e0d and 476181f.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/i18n-field-rendering-648

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.

Copy link
Copy Markdown
Member Author

@hanthor hanthor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

Changes: 2 files (+48 lines). CONTRIBUTING.md (+42) and vite.config.ts (+6).

CONTRIBUTING.md — i18n rendering docs ✅

  • ✅ Comprehensive field-type reference with 24 Markdown fields, 2 HTML fields, and plain-text default
  • ✅ Clear component attribution for each field
  • ✅ Practical guidance — translators can now avoid broken markup
  • ✅ Well-positioned after the "Adding a new language" section

vite.config.ts ⚠️

  • The coverage thresholds change is identical to PR #655 (closes #651). If #655 merges first, this will cause a trivial merge conflict. If this merges first, #655 becomes redundant. Either merge order works — just ensure only one lands.

Verdict

The CONTRIBUTING.md changes are correct and well-structured. The vite.config.ts overlap with #655 is minor and will self-resolve on merge. LGTM.

Copy link
Copy Markdown
Member Author

@hanthor hanthor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed — clear docs on i18n locale field rendering types (markdown vs plain HTML). Closes #648. LGTM.

@castrojo castrojo enabled auto-merge June 5, 2026 06:11
castrojo
castrojo previously approved these changes Jun 5, 2026
Copy link
Copy Markdown
Contributor

@castrojo castrojo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The locale field rendering type documentation is exactly the kind of contributor guidance that belongs in CONTRIBUTING.md. Merging.

@hanthor hanthor dismissed castrojo’s stale review June 5, 2026 12:59

The merge-base changed after approval.

Copy link
Copy Markdown
Contributor

@castrojo castrojo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-approving after rebase on main. The locale field rendering type docs are valuable for translators. All checks pass.

castrojo
castrojo previously approved these changes Jun 5, 2026
Copy link
Copy Markdown
Contributor

@castrojo castrojo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - approving again to clear stale review state. The i18n locale rendering docs are good.

Translators have no way to know which locale keys support Markdown,
which accept raw HTML, and which are plain text only. Using the wrong
markup produces literal asterisks/tags in the rendered page.

Add a "Locale field rendering" subsection under the i18n instructions
with three tables covering all 26 Markdown fields, the 2 raw-HTML fields
(Bazaar.Description / Bazaar.Additional), and a plain-text note for the
remainder.

Closes #648

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@castrojo castrojo force-pushed the docs/i18n-field-rendering-648 branch from ce4d858 to 476181f Compare June 5, 2026 13:11
Copy link
Copy Markdown
Contributor

@castrojo castrojo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rebased cleanly onto main. LGTM - the locale field rendering documentation is valuable for translators.

@castrojo castrojo added this pull request to the merge queue Jun 5, 2026
Merged via the queue into main with commit 1bcf7a1 Jun 5, 2026
3 checks passed
@castrojo castrojo deleted the docs/i18n-field-rendering-648 branch June 5, 2026 13:12
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.

📖 docs(contributing): document which i18n locale fields support markdown vs plain HTML

2 participants