Docs: Add "something unclear?" footer to all docs pages

klieret · klieret · commit bd076e4b8023 · 2025-11-04T17:22:16.000-05:00
diff --git a/docs/_footer.md b/docs/_footer.md
@@ -0,0 +1,21 @@
+<div class="grid cards">
+  <a href="https://github.com/emagedoc/CodeClash/issues/new" class="nav-card-link">
+    <div class="nav-card">
+      <div class="nav-card-header">
+        <span class="material-icons nav-card-icon">bug_report</span>
+        <span class="nav-card-title">Something broken/unclear?</span>
+      </div>
+      <p class="nav-card-description">Open an issue on GitHub!</p>
+    </div>
+  </a>
+
+  <a href="https://join.slack.com/t/codeclash-workspace/shared_invite/your-invite-link" class="nav-card-link">
+    <div class="nav-card">
+      <div class="nav-card-header">
+        <span class="material-icons nav-card-icon">help</span>
+        <span class="nav-card-title">Open-ended discussions</span>
+      </div>
+      <p class="nav-card-description">Join our Slack!</p>
+    </div>
+  </a>
+</div>
diff --git a/docs/assets/navigation_cards.css b/docs/assets/navigation_cards.css
@@ -0,0 +1,43 @@
+/* Navigation cards styling */
+.nav-card-link {
+  text-decoration: none;
+  color: inherit;
+  display: block;
+}
+
+.nav-card {
+  padding: 1rem;
+  border: 1px solid var(--md-default-fg-color--lighter);
+  border-radius: 0.5rem;
+  transition:
+    box-shadow 0.2s,
+    transform 0.2s;
+}
+
+.nav-card:hover {
+  box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
+  transform: translateY(-2px);
+}
+
+.nav-card-header {
+  display: flex;
+  align-items: center;
+  margin-bottom: 0.5rem;
+}
+
+.nav-card-icon {
+  margin-right: 0.5rem;
+  font-size: 1.2rem;
+  color: var(--md-default-fg-color);
+}
+
+.nav-card-description {
+  margin: 0;
+  color: var(--md-default-fg-color--light);
+}
+
+.nav-card-title {
+  margin: 0;
+  font-weight: bold;
+  color: var(--md-default-fg-color);
+}
diff --git a/docs/index.md b/docs/index.md
@@ -44,3 +44,5 @@ If you use CodeClash in your research, please cite:
 ```bibtex
 
 ```
+
+--8<-- "docs/_footer.md"
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -141,3 +141,5 @@ Use the trajectory viewer to step through each round and see:
 - [Learn about tournaments](usage/tournaments.md)
 - [Explore the API](reference/index.md)
 - [Build custom agents](reference/player/player.md)
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/battlecode.md b/docs/reference/arenas/battlecode.md
@@ -16,3 +16,5 @@ BattleCode is a programming competition where players write Java code to control
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/battlesnake.md b/docs/reference/arenas/battlesnake.md
@@ -49,3 +49,5 @@ players:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/corewar.md b/docs/reference/arenas/corewar.md
@@ -39,3 +39,5 @@ players:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/dummy.md b/docs/reference/arenas/dummy.md
@@ -32,3 +32,5 @@ players:
   - name: TestAgent
     model: gpt-4
 ```
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/game.md b/docs/reference/arenas/game.md
@@ -53,3 +53,5 @@ Each game runs in its own Docker container with:
     options:
       show_root_heading: true
       heading_level: 3
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/halite.md b/docs/reference/arenas/halite.md
@@ -40,3 +40,5 @@ players:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/halite2.md b/docs/reference/arenas/halite2.md
@@ -16,3 +16,5 @@ Halite II introduces planetary docking, combat, and more complex strategies.
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/halite3.md b/docs/reference/arenas/halite3.md
@@ -16,3 +16,5 @@ Halite III returns to the resource collection mechanics with new twists.
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/huskybench.md b/docs/reference/arenas/huskybench.md
@@ -16,3 +16,5 @@ Huskybench is an implementation of Husky Hold'em
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/robocode.md b/docs/reference/arenas/robocode.md
@@ -40,3 +40,5 @@ players:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/arenas/robotrumble.md b/docs/reference/arenas/robotrumble.md
@@ -36,3 +36,5 @@ players:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -61,3 +61,5 @@ Each component runs in isolated Docker containers:
 
 - **Game Container**: Runs the game engine
 - **Player Containers**: Provide isolated environments for agent code
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/player/dummy.md b/docs/reference/player/dummy.md
@@ -27,3 +27,5 @@ players:
   - name: DummyPlayer
     type: dummy
 ```
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/player/minisweagent.md b/docs/reference/player/minisweagent.md
@@ -30,3 +30,5 @@ players:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/player/player.md b/docs/reference/player/player.md
@@ -44,3 +44,5 @@ Players maintain git history:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/tournament/pvp.md b/docs/reference/tournament/pvp.md
@@ -48,3 +48,5 @@ tournament:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/tournament/single_player.md b/docs/reference/tournament/single_player.md
@@ -39,3 +39,5 @@ python main_single_player.py configs/single_player/config.yaml
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/docs/reference/tournament/tournament.md b/docs/reference/tournament/tournament.md
@@ -80,3 +80,5 @@ Tournament metadata is stored in `metadata.json`:
     options:
       show_root_heading: true
       heading_level: 2
+
+--8<-- "docs/_footer.md"
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -63,9 +63,8 @@ markdown_extensions:
 nav:
   - Leaderboard: https://codeclash.ai/
   - Docs:
-    - Getting Started:
-      - "Overview": index.md
-      - "Quick Start": quickstart.md
+    - "About": index.md
+    - "Quick Start": quickstart.md
     - API Reference:
       - "reference/index.md"
       - Arenas:
@@ -117,6 +116,8 @@ plugins:
 
 extra_css:
   - assets/custom.css
+  - assets/navigation_cards.css
+  - https://fonts.googleapis.com/icon?family=Material+Icons
 
 extra:
   analytics:
