docs(kudos): document the real wall-of-fame JSON payload shape - #40
Merged
Conversation
## Summary Agents parsing `dailybot kudos wall-of-fame --json` had no payload reference and could easily misread it — the person is nested under a `user` key, the leaderboard is a paginated envelope, and `leaderboard_summary` is the caller's own standing. The Dailybot CLI itself shipped exactly that misparse in its human rendering (fixed in DailybotHQ/cli#71), so the shape is now documented at the source agents actually read. ## Change Log - Annotated JSON example of the full wall-of-fame response - Called out the three commonly-misread fields (nested user.full_name, leaderboard.results envelope, leaderboard_summary = caller position) - Version note: CLI >= 3.7.2 renders the full wall of fame for humans; older versions show dashes — prefer --json for parsing and suggest `dailybot upgrade` when dashes appear Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…f-fame version note The wall-of-fame rendering fix (DailybotHQ/cli#71) is now published as v3.7.2 on PyPI, so the version note links to the concrete release instead of describing the behavior as a bare version floor. Co-Authored-By: Claude Fable 5 <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
1 participant
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
Agents parsing
dailybot kudos wall-of-fame --jsonhad no payload reference in the kudos sub-skill and could easily misread the response. The Dailybot CLI itself shipped exactly that misparse in its human rendering (Top receiver —/Leaderboard entries 4— fixed in DailybotHQ/cli#71, released asdailybot-cliv3.7.2, now the latest on PyPI), which proves the shape is genuinely easy to get wrong. This documents it at the source agents actually read.What the docs now call out
Three commonly-misread fields, with a full annotated JSON example:
user— the name is attop_receiver.user.full_name, not a top-levelfull_name. Same fortop_giverand every leaderboard entry.leaderboardis a paginated envelope —{count, next, previous, results}; the ranked entries live inresults(counting the envelope's keys gives you a meaningless4).leaderboard_summaryis the caller's own standing —{position, total}.Plus a version note pinned to the shipped release: since v3.7.2 the human (non-
--json) output renders the full wall of fame (top receiver/giver with counts, caller position, kudos-DNA distribution, ranked leaderboard table); older versions show dashes — so agents should prefer--jsonfor parsing and suggestdailybot upgradewhen a developer sees dashes.Scope
Doc-only change to
skills/dailybot/kudos/SKILL.md. Frontmatter untouched (version stays automation-owned). The pack-wide CLI baseline stays at>= 3.7.0— wall-of-fame parsing guidance applies to every baseline version; only the human rendering quality is version-gated, and that's what the note covers.🤖 Generated with Claude Code