docs(gamification): align XP Rewards table with code (#12501) - #12667
Merged
diegosouzapw merged 1 commit intoSep 5, 2026
Merged
Conversation
This was referenced Sep 4, 2026
Closed
Contributor
Author
Note (transparency)I'm posting this on the PRs I opened during a self-imposed WAITING window. There's a pending handoff in my local state ( What I'm doing now:
If any of these PRs shouldn't have been opened in your view, the comment-thread on each is the right place to flag it — I'll defer. Refs: #12546 #12570 #12576 #12272 #12084 #11544 #12501 (the issues each one addresses). — KooshaPari |
) The XP Rewards table in docs/frameworks/GAMIFICATION.md contained 12 entries but the canonical XP_REWARDS Record in src/lib/gamification/xp.ts has 10. Discrepancies: - 3 phantom entries not in code: badge_earned, streak_milestone, referral - 3 code entries missing from docs: model_switch, streak_bonus, badge_unlock - Wrong XP values for token_share (5 -> 1) and daily_login (3 -> 5) Code is the source of truth (it's what actually awards XP). Aligned the docs table to match code exactly with matching keys, values, and descriptions extracted from the TS interface comments. Fixes diegosouzapw#12501 (cherry picked from commit 49f2749)
diegosouzapw
force-pushed
the
pr/12501-gamification-docs
branch
from
September 5, 2026 05:32
49f2749 to
581e055
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.
Summary
Fixes #12501
The XP Rewards table in
docs/frameworks/GAMIFICATION.mdcontained 12 entries but the canonicalXP_REWARDSRecord insrc/lib/gamification/xp.tshas 10.Discrepancies
badge_earned,streak_milestone,referralmodel_switch,streak_bonus,badge_unlocktoken_share(5 → 1) anddaily_login(3 → 5)Fix
Aligned the docs table to match code exactly — keys, values, and descriptions are now identical. Descriptions were extracted from the TS interface comments in
src/lib/gamification/xp.ts.Code is the source of truth (it's what actually awards XP). The docs drift caused contributors reading the docs to set wrong expectations about what the system actually rewards.
Verification
Keys now match.
Fixes #12501