diff --git a/docs/guides/how-to-manage-cards.md b/docs/guides/how-to-manage-cards.md new file mode 100644 index 0000000..5a0bae1 --- /dev/null +++ b/docs/guides/how-to-manage-cards.md @@ -0,0 +1,2 @@ +# How to manage cards + diff --git a/docs/guides/how-to-play.md b/docs/guides/how-to-play.md new file mode 100644 index 0000000..2192951 --- /dev/null +++ b/docs/guides/how-to-play.md @@ -0,0 +1 @@ +# How to play Viral Spiral \ No newline at end of file diff --git a/lib/viral_spiral/game.ex b/lib/viral_spiral/game.ex index 38f40cc..adba49e 100644 --- a/lib/viral_spiral/game.ex +++ b/lib/viral_spiral/game.ex @@ -5,7 +5,9 @@ defmodule ViralSpiral.Game do scores: nil @moduledoc """ - # Rounds and Turns + Context for the game. + + Rounds and Turns round = Round.new(players) round_order = Round.order(round) During a Round every player gets to draw a card and then take some actions. diff --git a/mix.exs b/mix.exs index 9828afa..0f76bdc 100644 --- a/mix.exs +++ b/mix.exs @@ -1,5 +1,11 @@ defmodule ViralSpiral.MixProject do use Mix.Project + alias ViralSpiral.Game.Turn + alias ViralSpiral.Game.Round + alias ViralSpiral.Game.Room + alias ViralSpiral.Game.Player + alias ViralSpiral.Game + alias ViralSpiral.Canon def project do [ @@ -22,7 +28,19 @@ defmodule ViralSpiral.MixProject do "docs/architecture.md", "docs/community.md", "docs/nomenclature.md", - "docs/daily-notes.md" + "docs/daily-notes.md", + "docs/guides/how-to-manage-cards.md", + "docs/guides/how-to-play.md" + ], + groups_for_extras: [ + Introduction: Path.wildcard("docs/*.md"), + Guides: Path.wildcard("docs/guides/*.md") + ], + groups_for_modules: [ + "Game Text": [~r"ViralSpiral.Canon"], + "Data Model": [~r"ViralSpiral.Game"], + "User Interface": [~r"ViralSpiralWeb"], + Context: [~r"ViralSpiral"] ] ] ]