Open benjaminpjones opened 1 year ago
I would like to work on this in future, and have some ideas on how this could be structured. What do you think of the following?
New page available from nav-bar called "Tutorial" or maybe "Rules"
Users can select a variant that they want to learn about. Then the page contains rules explanations and demo boards where users can try it out by playing moves.
The rules explanations could be divided into modules that are potentially reusable by multiple variants (and have their own components). For example a module about parallel moves could be included in both pages for Parallel and for Fractional.
Nice-to-have: cross-reference links between module sections
We'll need to keep these updated though, whenever we change the rules of a variant.
Sounds like a lot of work, but also very nice!
Awesome! I think that plan sounds good to me :)
When I wrote this issue, all I had in mind was a page with:
I didn't think much about how it should be linked from the main page, but menu item, as you suggested, sounds nice. Or potentially a link near the game creation form on the home page after you've selected the variant.
I should say, I dont feel strongly about any details of these pages. The main use case I envisioned was to be able to share new variants:
I just added Quantum Go to the website! Check it out! https://govariants.com/variants/quantum
Ah, so each variant should get their own page then. I was thinking of one page where users can select a variant, but that wouldn't be easily linked.
That's what I had in mind at least, but if it's preferable to have all this on one page, maybe we can support linking with query params?
https://govariants.com/rules?variant=quantum
And that would automatically set the selector to "quantum".
I'm not sure if its preferable, but I think it should be one page that's linked from the navbar. We could use a similar structure as this site: https://gamerules.com/browse-all-rules/
Is someone is still working on this?
Here's a checklist for which variants have rules pages that I could find just by trying to plug the name into the URL. I also included the short description for each one.
I think the simplest possible version of a rules page should have the above content (with my comments removed, and links to the full rules page if one exists). IMO, such a page should get added to the site and navigation ASAP!
Other ideas and opinions:
Hello, thank you for the checklist! I'm planning to add more detailed rule descriptions. I've been hesitant to add navigation to these because I'm not sure yet how the variant pages should ultimately look like, and because we don't have a lot of rule descriptions to show off yet.
It would be ideal if each variant's rules are in some easily editable format (markdown seems good), so that anyone could put in a PR to edit one.
Good points, and thanks to @benjaminpjones feedback, this is the case currently. If you want to take a look at the markdown: https://github.com/govariantsteam/govariants/tree/main/packages/shared/src/templates
My thinking is that once the detailed description of a variants rules are accessible, maybe we don't need the short description any more.
Currently, the only option is to link to an ongoing game.
For example,
govariants.com/variants/baduk
Each page could have a blurb on the rules, screenshots, and a create game form. Maybe instead of screenshots, an analysis board (see #13) and/or example game.