Repository navigation
Conversation
8 of 13 tasks
Adds a dedicated 'Localizing gambit keywords' section to search.md covering how key() drives localized search tokens, the canonicalKey() English fallback, examples for both KeyValueGambit and BooleanGambit, toFilter() canonical value mapping, and a subsection for language pack maintainers. Adds a brief note in update-2_0.md flagging canonicalKey() as a required change for translated gambits. Adds a pointer in language-packs.md explaining gambit keyword translation keys.
imorland
force-pushed
the
im/gambit-localization-docs
branch
from
October 19, 2026 18:31
3a469cf to
53e58b9
Compare
This branch has not been deployed
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.
Fixes #0000 (no issue: documents flarum/framework#4570, which fixes flarum/framework#4566)
Changes proposed in this pull request:
Documents the English fallback for gambit keywords that flarum/framework#4570 adds in Flarum 2.1.
search.mdgets a "Localizing gambit keywords" section oncanonicalKey(), mapping matched keywords to stable filter values, and translating keywords;language-packs.mdpoints language pack maintainers to it; and the 2.1 section of the 2.x upgrade guide tells extension authors to overridecanonicalKey()when theirkey()is translated.Reviewers should focus on:
Screenshot
N/A
Necessity
Confirmed
yarn testinjs/). (No code changes.)composer test). (No code changes.)