Repository navigation
Version 1 use cases
Generated from
docs/explanation/use-cases.md. Edit that file in the repository: changes made in the wiki are overwritten.
These diagrams cover player, raid officer, and community administrator goals. An officer also has player capabilities; a community administrator also has officer capabilities. Actual permissions remain scoped to the selected community.
The full goal map covers the website, Discord bot, addon, and companion as one RaidManager system. Discord, the WoW client, and Warmane Armory are supporting external actors.
Source: PlantUML.
| Goal | Version 1 behavior | Detailed flow |
|---|---|---|
| UC-01 Access a community | Discord sign-in, local identity, membership and permission checks. | Sign-in |
| UC-02 Connect game data | Pair and revoke companion, select account folders, pause sync, observe failures and retries. | Pairing and sync |
| UC-03 Manage characters | Approve or reject discovery, surface conflicts, inspect profiles, edit reported fields and visibility. | Approval |
| UC-04 Inspect readiness | View saves, resets, freshness, per-target verdicts and gear warnings. | Readiness |
| UC-05 Respond to a raid | Offer multiple specs, choose a favorite, add notes, reuse presets, set availability or withdraw. | Signup |
| UC-06 Follow raid updates | View assigned character, bench and boss plan; receive reminders and material changes. | Delivery |
| UC-07 Schedule raids | Create and edit targets, templates, weekly recurrence, time zone, deadline, and signup closure. | Scheduling |
| UC-08 Build compositions | Search candidates; duplicate and compare drafts; inspect role, buff, debuff and gear coverage. | Publication |
| UC-09 Publish rosters | Review changes, validate conflicts, record unknown-data exceptions and notify selected or benched players. | Re-evaluation |
| UC-10 Run raid night | Check attendance, handle late arrivals, swap substitutes, use boss assignments and export invitations. | Raid night |
| UC-11 Review attendance | Inspect participation history across raids. | Raid planning model |
| UC-12 Manage permissions | Maintain community membership and officer permissions. | API components |
A player can use the website or Discord for participation, while the companion manages local synchronization. The ownership-conflict extension interrupts approval; it does not transfer another player's character.
Source: PlantUML.
The character/spec selection subcase applies when offering characters. A declined response can omit character options. Presets copy choices into the current raid response; every copied choice is checked again for that raid. Manual edits remain player-reported and never replace authoritative synchronized save evidence.
Officers review candidates, publish compositions, and manage raid-night changes. The exception extension applies only to unknown data; confirmed active locks remain blocking.
Source: PlantUML.
In UML, an include relationship marks required behavior in the relevant use case.
An extend relationship marks conditional behavior.
Notification dispatch is required after a material publication change, but transport completion can follow later.
Community administration does not imply authority to transfer ownership of another account's character.
- Product scope
- Architecture
- Visual guide
- Diagram maintenance
- Review a pull request
- Design a screen
- Test the addon
- Set up Discord
- Provision the server
- Glossary
- API contracts
- Addon snapshot contract
- Project automation
- Work management specification
- Warmane lockout evidence
- Planning
-
Decisions
- Index
- Foundation and authentication
- Character synchronization
- Documentation publication
- Protected automatic squash merges
- Viewed files before approval
- Operator review before a peer
- Auto-merge when ready
- Merge with the workflow token
- Meaningful review comments
- Read queries from the write database
- Website session and API trust
- Interactive Server rendering with Radzen
- Scalar API reference
- GitHub Wiki mirror
- Coverage gate
- Work item hierarchy
- Penpot mockups
- Generated Penpot mockups
- Dark design system
- SonarCloud findings
- Addon roster import
- Discord role checks
- Discord servers at sign-in
- Community roles
- Work item classification
- Work management specification adoption
- OVH test environment
- Environment secrets
- PostgreSQL
- Companion pairing
- WoW addon in Lua
- Windows companion in Avalonia
- Companion in the Microsoft Store
- Workflows on a self-hosted runner