add sidebar

lochungtin · Dec 29, 2023 · 94d0ca3 · 94d0ca3
1 parent 5cecb82
commit 94d0ca3
Show file tree

Hide file tree

Showing 16 changed files with 48 additions and 27 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -10,18 +10,6 @@ Project Expedite is my attempt to create solutions, algorithms, or solvers to cl
 
 3. **Robustness** - The solution should be able to adapt to different "difficulty" levels of the game, whatever that may mean to the game, be it grid size or available options.
 
-## Usage
-
-Setup an environment with any python version `> 3.7` and run the command in the root directory.
-
-```bash
-python3 main.py --gamemode <gamemode> --config <config_file_index>
-
-python3 main.py -g <gamemode> -c <config_file_index>
-```
-
-Run the command `python3 main.py --help` for more information.
-
 ## Directory and Status
 
 The following list shows the puzzle games for this project and their respective status in solution development.
@@ -30,21 +18,21 @@ This list will be expanded upon and updated as status for sub-projects change an
 
 <div align="center">
 
-| Game                                        | Algorithm Status                                            |
-| :------------------------------------------ | :---------------------------------------------------------- |
-| [2048](./docs/2048.md)                      | 📒 Backlog                                                  |
-| [Kuromasu](./docs/Kuromasu.md)              | ✅ Complete                                                 |
-| [Mastermind](./docs/Mastermind.md)          | 🛑 Paused                                                   |
-| [Mine Sweeper](./docs/MineSweeper.md)       | ✅ Complete                                                 |
-| [Nonogram](./docs/Nonogram.md)              | 🛑 Paused                                                   |
-| [Numberlink](./docs/Numberlink.md)          | 📒 Backlog                                                  |
-| [Slitherlink](./docs/Slitherlink.md)        | 📒 Backlog                                                  |
-| [Snake](./docs/Snake.md)                    | ✅ [Partly Complete](https://github.com/lochungtin/snakeAI) |
-| [Sudoku](./docs/Sudoku.md)                  | ✅ Complete                                                 |
-| [Tazuku](./docs/Tazuku.md)                  | ✅ Complete                                                 |
-| [(NYT) SpellingBee](./docs/SpellingBee.md)  | ✅ Complete                                                 |
-| [(NYT) Wordle](./docs/Wordle.md)            | ✅ Complete                                                 |
-| [(NYT) Letter Boxed](./docs/LetterBoxed.md) | 📒 Backlog                                                  |
+| Game                                              | Algorithm Status                                            |
+| :------------------------------------------------ | :---------------------------------------------------------- |
+| [2048](./docs/games/2048.md)                      | 📒 Backlog                                                  |
+| [Kuromasu](./docs/games/Kuromasu.md)              | ✅ Complete                                                 |
+| [Mastermind](./docs/games/Mastermind.md)          | 🛑 Paused                                                   |
+| [Mine Sweeper](./docs/games/MineSweeper.md)       | ✅ Complete                                                 |
+| [Nonogram](./docs/games/Nonogram.md)              | 🛑 Paused                                                   |
+| [Numberlink](./docs/games/Numberlink.md)          | 📒 Backlog                                                  |
+| [Slitherlink](./docs/games/Slitherlink.md)        | 📒 Backlog                                                  |
+| [Snake](./docs/games/Snake.md)                    | ✅ [Partly Complete](https://github.com/lochungtin/snakeAI) |
+| [Sudoku](./docs/games/Sudoku.md)                  | ✅ Complete                                                 |
+| [Tazuku](./docs/games/Tazuku.md)                  | ✅ Complete                                                 |
+| [(NYT) SpellingBee](./docs/games/SpellingBee.md)  | ✅ Complete                                                 |
+| [(NYT) Wordle](./docs/games/Wordle.md)            | ✅ Complete                                                 |
+| [(NYT) Letter Boxed](./docs/games/LetterBoxed.md) | 📒 Backlog                                                  |
 
 </div>
 

diff --git a/docs/Usage.md b/docs/Usage.md
@@ -0,0 +1,15 @@
+# Usage
+
+Setup an environment with any python version `> 3.7` and run the command in the root directory.
+
+```bash
+python3 main.py --gamemode <gamemode> --config <config_file_index>
+
+python3 main.py -g <gamemode> -c <config_file_index>
+```
+
+Run the command `python3 main.py --help` for more information.
+
+## Configs <!-- {docsify-ignore} -->
+
+Each game has its separate config file format, please refer to the doc file for each game.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,18 @@
+-   [Home](./)
+-   [Usage](./Usage)
+
+---
+
+-   [2048](./games/2048.md)
+-   [Kuromasu](./games/Kuromasu.md)
+-   [Mastermind](./games/Mastermind.md)
+-   [Mine Sweeper](./games/MineSweeper.md)
+-   [Nonogram](./games/Nonogram.md)
+-   [Numberlink](./games/Numberlink.md)
+-   [Slitherlink](./games/Slitherlink.md)
+-   [Snake](./games/Snake.md)
+-   [Sudoku](./games/Sudoku.md)
+-   [Tazuku](./games/Tazuku.md)
+-   [(NYT) SpellingBee](./games/SpellingBee.md)
+-   [(NYT) Wordle](./games/Wordle.md)
+-   [(NYT) Letter Boxed](./games/LetterBoxed.md)
diff --git a/docs/2048.md → docs/games/2048.md b/docs/2048.md → docs/games/2048.md
diff --git a/docs/Kuromasu.md → docs/games/Kuromasu.md b/docs/Kuromasu.md → docs/games/Kuromasu.md
diff --git a/docs/LetterBoxed.md → docs/games/LetterBoxed.md b/docs/LetterBoxed.md → docs/games/LetterBoxed.md
diff --git a/docs/Mastermind.md → docs/games/Mastermind.md b/docs/Mastermind.md → docs/games/Mastermind.md
diff --git a/docs/MineSweeper.md → docs/games/MineSweeper.md b/docs/MineSweeper.md → docs/games/MineSweeper.md
diff --git a/docs/Nonogram.md → docs/games/Nonogram.md b/docs/Nonogram.md → docs/games/Nonogram.md
diff --git a/docs/Numberlink.md → docs/games/Numberlink.md b/docs/Numberlink.md → docs/games/Numberlink.md
diff --git a/docs/Slitherlink.md → docs/games/Slitherlink.md b/docs/Slitherlink.md → docs/games/Slitherlink.md
diff --git a/docs/Snake.md → docs/games/Snake.md b/docs/Snake.md → docs/games/Snake.md
diff --git a/docs/SpellingBee.md → docs/games/SpellingBee.md b/docs/SpellingBee.md → docs/games/SpellingBee.md
diff --git a/docs/Sudoku.md → docs/games/Sudoku.md b/docs/Sudoku.md → docs/games/Sudoku.md
diff --git a/docs/Tazuku.md → docs/games/Tazuku.md b/docs/Tazuku.md → docs/games/Tazuku.md
diff --git a/docs/Wordle.md → docs/games/Wordle.md b/docs/Wordle.md → docs/games/Wordle.md