docs: add site-messages README#20
Open
brian-smith-tcril wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Adds
src/i18n/site-messages/README.mddocumenting the operator-managed local translations directory.Why
The frontend-base i18n pipeline added in openedx/frontend-base#205 (part of openedx/frontend-base#176) introduced
src/i18n/site-messages/as the checked-in, operator-managed location for site-local translation JSON files. The layout in this repo is:(The frontend-base migration guide documents this re-export module as
index.ts; this repo landed it asindex.jsin #11 — that discrepancy is out of scope here.)translations:preparegenerates a gitignoredsite-messages/index.tsfrom the JSON files an operator drops in this directory, and those strings are merged in last so they can override strings pulled from packages. The repo's.gitignorealready referencessrc/i18n/site-messages/index.ts, but the directory itself and its explanatory README were never committed — the README only ever existed in the throwaway testing PR #10, which was closed without merging.This adds the README so the directory exists in a fresh clone and operators understand what to put there. The content matches what was in PR #10.
🤖 Generated with Claude Code