Provinite / Provinite/chardb

Docs: community badges are undocumented (and currently only a trait convention)

Open
#347 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation low priority
Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
2h 52m
Merged PRs (30d)
85

Description

Ask

Product docs for community badges.

Finding: they do not exist, and neither does the feature

Checked both:

No doc. docs/docs/ has 18 pages — character-deletion, character-rarity, currency, edit-kits, fuzzy-navigation, image-moderation, image-uploads, item-ledger, markdown-formatting, member-characters, myo-slots, notifications, shop, trading, trait-clarifiers, trait-review, using-items, variant-change-items. Nothing on badges. The only "badge" strings in docs/index.html (:330, :379) refer to the edit-kit pending badge and the notification count badge — unrelated UI chrome.

No feature. grep -ri "community badge" across apps/ and packages/ returns nothing. It does not appear in the seed data either.

What exists is a convention: "Community Badges" is a trait category someone defined on the Cloverse species. It shows up in the traits display on a character page (visible in the screenshot on #340, holding the value "CloverCoin Design") because it is a trait like any other.

So what gets documented depends on an answer

Two readings, and they produce different work:

A. Document the convention. A page explaining that communities can express badges as a trait category — how to set one up, what it looks like on the character page, and what the tradeoffs are. Namely: badges-as-traits pass through trait review, are constrained by the variant's trait list, get snapshotted into TraitReview and CharacterVariantChange, and sit in the traits display next to real traits. Cheap, honest, and immediately useful to any community wanting the same thing.

B. Community badges should be a real feature, and the docs request is really a feature request wearing a docs hat. In that case this is a sibling of #346 (character sticker boards / achievements), which is the same idea aimed at characters, and the two should be designed together rather than arriving as separate mechanisms for the same job.

Recommend A now — the convention is live and undocumented regardless of what happens later — with B raised as its own question.

One targeted question

Is "community badges" meant to be a badge on a character (which is what the Cloverse trait does today) or a badge on a community, or on a member of a community? All three are plausible readings of the phrase and they are different features. The answer decides whether this is a doc page or a design issue.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

First resolve whether this documents the existing community-badges trait convention or proposes a new feature, including whether badges belong to characters, communities, or members. If documenting the convention, review the existing pages under docs/docs/ and the trait-related behavior named in the issue. Done means a focused page explains setup, character-page display, trait review, snapshots, variant constraints, and tradeoffs.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.