fix(i18n): add callout clarifying write-translations only handles JSO…#12119
Open
MasterIfeanyi wants to merge 1 commit into
Open
fix(i18n): add callout clarifying write-translations only handles JSO…#12119MasterIfeanyi wants to merge 1 commit into
MasterIfeanyi wants to merge 1 commit into
Conversation
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
b3b2653 to
6f4ebc2
Compare
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
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.
Pre-flight checklist
Motivation
Users running the
write-translationscommand often expect it to copy their Markdown files to the i18n folder, but it only generates JSON translation files for UI strings and plugin data. This causes confusion, especially for new users setting up multi-language sites.This PR addresses #8703 by:
write-translationsruns, clearly stating thecommand only handles JSON files and linking to Markdown translation docs
:::notecallout in the i18n tutorial at the exact point of confusion,signposting users to the "Translate Markdown files" section
Closes #8703
Test Plan
Code change:
pnpm startto build the projectDocs change:
:::notecallout renders correctly on the local dev server#translate-markdown-filescorrectly scrolls to the right sectionTest links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs
Closes #8703