Repository navigation
docs: showcase every style and publish usage badges - #1185
Merged
Merged
Conversation
Add /badges/pcs.json and /badges/users.json to the hosted service, publishing the aggregate registration and sign-in totals the privacy doc already sanctions. Show the three usage badges in the README and document the endpoints for self-hosters. Fix the stale docs the redesign left behind: the wiki theme list, the dev-build QA checklist, the Discord preview pointer, the troubleshooting note about shipped diagnostic headers, and the docs index. Show the Classic film and TV examples that were generated but never embedded, and show all six styles on the README.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
The README now shows all six card styles and three live usage badges, and the hosted service publishes the aggregate sign-in and registration totals that the privacy documentation already describes.
/badges/pcs.jsonand/badges/users.jsonto the hosted service alongside/badges/requests.json. Each serves a Shields endpoint badge for one aggregate total (np:stats:registrations,np:stats:users), cached for five minutes, with a503 unavailablefallback and nothing per card, per user or per device.docs/hosted-upload.mdandhosted/README.md; correct the counters list to include the per-day user count.studio,editorialandterminal; the dev-build QA checklist exercises the shipped Appearance section, all six styles and the Include cover art toggle; the Discord wiki points at Settings → Appearance → Card Settings; the troubleshooting page describes the shipped diagnostic headers instead of the closed issue; the docs index gains release notes, ways-to-help and guide skeleton entries; the Classic gallery section now shows music, film and TV using the two showcase SVGs that were committed but never embedded.Validation:
test/card-examples.test.js, so embedded examples cannot drift from the renderer.Deployment: the badges go live when the hosted service deploys after merge; until then the Shields badges fall back to their error state. This PR does not deploy production.