Skip to content

docs: document lifecycle session badges#41

Merged
zzJinux merged 1 commit into
masterfrom
docs/session-badges-renewal
May 26, 2026
Merged

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

Conversation

@zzJinux

@zzJinux zzJinux commented May 19, 2026

Copy link
Copy Markdown
Collaborator

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
@zzJinux zzJinux requested a review from gavin-jeong May 26, 2026 09:16

@gavin-jeong gavin-jeong left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 Auto-reviewed by PR watcher. Docs-only update aligning README and CUSTOM_BADGES.md with the new lifecycle badge system (#39), including refreshed badge:toggle keys and hidden_badges example.

@zzJinux zzJinux merged commit 8cbefd8 into master May 26, 2026
3 checks passed
@zzJinux zzJinux deleted the docs/session-badges-renewal branch May 26, 2026 18:54
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.

2 participants