Skip to content

docs: document lifecycle session badges#41

Open
zzJinux wants to merge 1 commit into
masterfrom
docs/session-badges-renewal
Open

docs: document lifecycle session badges#41
zzJinux wants to merge 1 commit into
masterfrom
docs/session-badges-renewal

Conversation

@zzJinux
Copy link
Copy Markdown
Collaborator

@zzJinux zzJinux commented May 19, 2026

Summary

  • Add a Session Badges section to the README documenting independent badges ([HERE], [LIVE], [R·exp], custom) and the priority-ordered lifecycle badges ([BUSY] > [BG] > [STUCK] > [WAIT] > [DONE]) with trigger conditions mirroring internal/session/lifecycle.go.
  • Fix stale badge:toggle key list (M,W,T,K,P,A,C,S,X,F,LIVEHERE,LIVE,BUSY,BG,WAIT,DONE,STUCK) and hidden_badges example.
  • Scope docs/CUSTOM_BADGES.md to user-tag badges with a pointer to the README, and replace stale [LIVE] [M] [T] snippets.

The badge concept was reworked in #39 (has-X → lifecycle states) but markdown documentation was never updated; the in-app Help screen and source comments were the only accurate references.

Test plan

  • Render README on GitHub and confirm the new section and table display correctly
  • Cross-check lifecycle trigger conditions against internal/session/lifecycle.go
  • Verify badge:toggle keys match internal/tui/cmdmode.go

The badge concept was reworked in #39 (has-X → lifecycle states) but
the markdown docs were never refreshed. Add a Session Badges section
to the README describing independent badges ([HERE], [LIVE], [R·exp],
custom) and the priority-ordered lifecycle badges ([BUSY], [BG],
[STUCK], [WAIT], [DONE]) with their trigger conditions. Fix stale
`badge:toggle` key list and `hidden_badges` example. Scope
docs/CUSTOM_BADGES.md to user-tag badges and replace stale snippets.

Claude-Session: LOCAL_a57c2ed3-9a92-4bd7-814f-2b00e527a75d
@zzJinux zzJinux self-assigned this May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant