Skip to content

Commit

Permalink
feat: structure documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dennyabrain committed Aug 13, 2024
1 parent 951405d commit 9cdc6a5
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/guides/how-to-manage-cards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# How to manage cards

1 change: 1 addition & 0 deletions docs/guides/how-to-play.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# How to play Viral Spiral
4 changes: 3 additions & 1 deletion lib/viral_spiral/game.ex
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
20 changes: 19 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
defmodule ViralSpiral.MixProject do
use Mix.Project
alias ViralSpiral.Game.Turn

Check warning on line 3 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Turn

Check warning on line 3 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Turn

Check warning on line 3 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Turn
alias ViralSpiral.Game.Round

Check warning on line 4 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Round

Check warning on line 4 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Round

Check warning on line 4 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Round
alias ViralSpiral.Game.Room

Check warning on line 5 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Room

Check warning on line 5 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Room

Check warning on line 5 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Room

Check warning on line 5 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Room
alias ViralSpiral.Game.Player

Check warning on line 6 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Player

Check warning on line 6 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Player

Check warning on line 6 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Player

Check warning on line 6 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Player
alias ViralSpiral.Game

Check warning on line 7 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Game

Check warning on line 7 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Game

Check warning on line 7 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Game

Check warning on line 7 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Game
alias ViralSpiral.Canon

Check warning on line 8 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Canon

Check warning on line 8 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Canon

Check warning on line 8 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Canon

Check warning on line 8 in mix.exs

View workflow job for this annotation

GitHub Actions / build-and-deploy

unused alias Canon

def project do
[
Expand All @@ -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"]
]
]
]
Expand Down

0 comments on commit 9cdc6a5

Please sign in to comment.