debatecore / debate-tools

Battle-tested utilities to aid with Oxford format debates.
https://tools.debateco.re
GNU Affero General Public License v3.0
1 stars 3 forks source link

Create a debate configuration wizard #38

Open Mateusz-Dobrzynski opened 6 months ago

Mateusz-Dobrzynski commented 6 months ago

Proposed changes When the Oxford Debate Conduction button is clicked, a step-by-step configuration process is started. The user can navigate the wizard back and forth, as well as skip to the final screen (i.e. current configuration view). Less obvious aspects of the configuration can be explained in their respective views (with flavor texts and a hint button perhaps?):

  1. Pick debate preset (#5)
  2. Speech time (with minutes strings changing from singular to plural or in some other way avoiding the bug described in #36)
  3. Protected time (beginning/end/both, duration)
  4. Visual indication of protected time (with a clock preview)
  5. Beeps
    • Bell sound (default/ZTM/other – #25)
    • Speech end (enabled/disabled)
    • Protected time (enabled/disabled)
  6. Ad vocem (enabled/disabled, duration)
  7. Logos with a debate page preview (#35)
    • Logo below the clock
    • Proposition logo
    • Opposition logo
  8. Teams position with a preview (#27 and #31)
  9. Summary – given how many steps there are, the user should be able to edit the configuration in the final view. Going multiple steps back to fix something would be infuriating

Rationale As the list shows, there are already quite a few configuration options with more to come. Such an abundance could cause a headache to new users, even more so to beginning debaters. A configuration wizard would make it easier to understand and navigate. We want to make debating approachable, after all ✨

jakubmanczak commented 6 months ago

Along with this, I feel like the menu would benefit from a little restructuring.

image

Currently, under the "Debate Tools" header, we have three buttons corresponding to each distinct debate "tool" – debate conduction (should probably be renamed to debate clock??), the debate motion generator & the tournament planner. The sound preview only has to do with the first one, and occupies space. Maybe it should be moved to some option under the clock settings after this "wizard" view is complete?

~jm

Mateusz-Dobrzynski commented 6 months ago

I'm all for all of the above. What about Tournament Planner? Do we want to keep it there?

jakubmanczak commented 6 months ago

As a link I'd say yeah, why not?

jakubmanczak commented 6 months ago

This being said, there might also be merit in a standalone bell tool? Maybe it should just be renamed instead od being removed. 🤔

Mateusz-Dobrzynski commented 6 months ago

As the name suggests, its designed use case is sound demonstration at the beginning of the debate. Marshalls always demonstrate signals indicating the protected time and the end of the speech, be it ringing a physical bell or knocking on the table. There should be a way to demonstrate the sounds produced by the app and be easily accessible once the debate is configured. On a related note, configuring the debate, retracting from the debate clock to the main menu, opening the sound demo to present the signals, and then opening the clock again to conduct the debate surely is burdensome.

But the sound demonstration button doesn't have to be in the main menu. It can be anywhere else within the debate clock, as long as it makes sense. Maybe demonstration buttons would appear next to the clock (or instead of it) and vanish when the first speech starts? Just thinking out loud here.

jakubmanczak commented 5 months ago

This would also be a good time to introduce some kind of settings validation – not letting a user start proceed to the clock if the time is set to 0, or if protected time is greater than speech time, can't fit twice if twice option is selected etc.