docs: enhance navigation and update AI index

- Added custom CSS for top-level navigation tabs - Created stylesheets directory with extra.css - Added hover and active state effects - Moved AI Development Index to top-level nav - Added site description and author metadata - Updated today's log with navigation changes
MaterDev · Jan 17, 2025 · f5f0182 · f5f0182
1 parent 07fe689
commit f5f0182
Show file tree

Hide file tree

Showing 4 changed files with 128 additions and 95 deletions.
diff --git a/docs/AI_DEVELOPMENT_INDEX.md b/docs/AI_DEVELOPMENT_INDEX.md
@@ -10,121 +10,118 @@ This document serves as a master reference for AI agents during development of T
 ```yaml
 Root_Directories:
   docs: "Documentation and specifications"
-  server: "Go server implementation"
-  client: "TypeScript/React client"
-  ai: "Python AI components"
+  src: "Source code"
+  tests: "Test files"
   scripts: "Build and utility scripts"
+  images: "Project images and assets"
 
 Documentation_Structure:
   overview: "High-level project documentation"
   technical: "Technical specifications and APIs"
   implementation: "Implementation details and planning"
-  meta: "Development logs and metadata"
+  meta:
+    logs: "Development logs"
+    social: "Social media updates"
+    contributing: "Contribution guidelines"
   character_classes: "Game character specifications"
 ```
 
 ### Core Documentation
 ```yaml
-Architecture:
-  system_overview: "docs/overview/system-architecture.md"
-  server_design: "docs/implementation/server/architecture.md"
-  client_design: "docs/implementation/client/architecture.md"
-  ai_design: "docs/implementation/ai/architecture.md"
-
-Technical_Specs:
-  api_endpoints: "docs/technical/api/endpoints.md"
-  game_state: "docs/technical/game/state.md"
-  turn_system: "docs/technical/game/turns.md"
-  ai_interface: "docs/technical/ai/interface.md"
+Project_Overview:
+  documentation_site: "https://materdev.github.io/thepath-ai_pi/"
+  project_scope: "docs/overview/project-scope.md"
+  research_objectives: "docs/overview/research-objectives.md"
+  development_logs: "docs/meta/logs/index.md"
+  social_updates: "docs/meta/social/index.md"
+
+Development_Guidelines:
+  contributing: "docs/meta/contributing.md"
+  style_guide: "docs/meta/style-guide.md"
+  setup_guide: "docs/meta/implementation/setup/project-setup.md"
 ```
 
-### System Components
+### Documentation Standards
 ```yaml
-Game_State:
-  components:
-    - Character state management
-    - Turn system
-    - Combat actions
-    - State synchronization
-  key_docs: "docs/technical/game/state.md"
-
-Communication:
-  protocols:
-    - WebSocket events
-    - REST endpoints
-    - State synchronization
-  key_docs: "docs/technical/api/endpoints.md"
-
-AI_System:
-  components:
-    - Model inference
-    - Decision making
-    - Hardware acceleration
-    - Performance monitoring
-  key_docs: "docs/technical/ai/core.md"
-
-Game_Systems:
-  components:
-    - Turn management
-    - Combat mechanics
-    - Character classes
-    - Status effects
-  key_docs: "docs/technical/game/systems.md"
+Log_Format:
+  structure:
+    - Session overview with YAML metadata
+    - Focus areas
+    - Changes made
+    - Technical details
+    - Challenges and solutions
+    - Resources
+  location: "docs/meta/logs/*.md"
+
+Social_Updates:
+  structure:
+    - YAML frontmatter (date, platform, type, hashtags)
+    - Content in code blocks
+    - Hashtags
+  location: "docs/meta/social/linkedin/*.md"
+```
+
+### Development Workflow
+```yaml
+Documentation:
+  automated_updates:
+    - Log navigation
+    - Social media posts
+    - Site deployment
+  tools:
+    - MkDocs Material theme
+    - GitHub Pages
+    - GitHub Actions
+
+Version_Control:
+  branch_strategy:
+    main: "Primary development branch"
+  commit_conventions:
+    - "docs: Documentation updates"
+    - "feat: New features"
+    - "fix: Bug fixes"
+    - "chore: Maintenance"
 ```
 
 ### Technical Requirements
 ```yaml
-Performance:
-  ai_response_time_max: 100ms
-  server_update_time_max: 50ms
-  client_frame_time_max: 16ms
+Development:
+  python: "3.11+"
+  raspberry_pi: "5"
+  make: "Required for build scripts"
 
-Hardware:
-  platform: "Raspberry Pi 5"
-  ram: "8GB"
-  accelerator: "AI HAT+"
-  cooling: "Active"
+Documentation:
+  mkdocs: "Latest"
+  mkdocs_material: "Latest"
+  mkdocs_awesome_pages: "Latest"
+  python_yaml: "Latest"
+```
 
-Dependencies:
-  server: "Go 1.21+"
-  client: "Node.js 18+"
-  ai: "Python 3.11+"
-  database: "MongoDB 6+"
+### Project Phases
+```yaml
+Phase_1:
+  focus: "Core Systems"
+  status: "In Progress"
+  tracking: "docs/overview/project-scope.md"
+
+Phase_2:
+  focus: "Game Features"
+  status: "Planned"
+  tracking: "docs/overview/project-scope.md"
+
+Phase_3:
+  focus: "Polish & Launch"
+  status: "Planned"
+  tracking: "docs/overview/project-scope.md"
 ```
 
-### Development Resources
+### Resources
 ```yaml
-Test_Suites:
-  locations:
-    server: "server/tests/"
-    client: "client/tests/"
-    ai: "ai/tests/"
-  requirements:
-    coverage_minimum: 80%
-    critical_coverage: 90%
-
-Documentation_Standards:
-  required_sections:
-    - Purpose
-    - Technical Requirements
-    - Implementation Details
-    - Test Coverage
-    - Performance Metrics
-
-Quality_Standards:
-  code:
-    - Automated linting
-    - Type safety
-    - Error handling
-    - Performance monitoring
-  testing:
-    - Unit test coverage
-    - Integration tests
-    - Performance validation
-  documentation:
-    - Technical accuracy
-    - Implementation alignment
-    - Cross-reference validation
+External_Links:
+  mkdocs: "https://www.mkdocs.org/"
+  mkdocs_material: "https://squidfunk.github.io/mkdocs-material/"
+  github_pages: "https://docs.github.com/en/pages"
+  github_actions: "https://docs.github.com/en/actions"
 ```
 
 ## Core Specifications

diff --git a/docs/meta/logs/2025-01-17.md b/docs/meta/logs/2025-01-17.md
@@ -3,8 +3,8 @@
 ## Session Overview
 ```yaml
 type: Documentation and Infrastructure
-duration: 3.5 hours
-hashtags: [github-pages, documentation, theme-configuration, ci-cd, workflow-setup, social-media, readme, log-format]
+duration: 4 hours
+hashtags: [github-pages, documentation, theme-configuration, ci-cd, workflow-setup, social-media, readme, log-format, navigation]
 blockers: None
 ```
 
@@ -18,6 +18,7 @@ blockers: None
 * README simplification
 * Cover image optimization
 * Log format improvements
+* Navigation enhancements
 
 ## Changes Made
 
@@ -97,6 +98,16 @@ blockers: None
 * Improved log clarity and reduced redundancy
 * Rationale: Next steps are better tracked in phase-specific checklists for more accurate progress tracking and better organization
 
+### Navigation Improvements
+
+* Added custom CSS for top-level navigation
+* Created stylesheets directory with extra.css
+* Added subtle borders around navigation tabs
+* Implemented hover and active state effects
+* Added proper spacing and padding for tabs
+* Moved AI Development Index to top-level navigation
+* Added site description and author metadata
+
 ## Technical Details
 
 ### Key Configuration Changes

diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -0,0 +1,21 @@
+.md-tabs__link {
+    border: 1px solid rgba(255,255,255,0.1);
+    border-radius: 4px;
+    padding: 0.6rem 1rem !important;
+    margin: 0.4rem 0.2rem;
+}
+
+.md-tabs__link:hover {
+    border-color: var(--md-accent-fg-color);
+    background-color: rgba(255,255,255,0.05);
+}
+
+.md-tabs__link--active {
+    border-color: var(--md-accent-fg-color);
+    background-color: rgba(255,255,255,0.05);
+}
+
+.md-tabs__item {
+    height: auto !important;
+    padding: 0 !important;
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,6 @@
 site_name: The Path (AI-Pi)
+site_description: Edge AI-powered turn-based combat game running on Raspberry Pi hardware.
+site_author: MaterDev
 site_url: https://materdev.github.io/thepath-ai_pi/
 repo_url: https://github.com/MaterDev/thepath-ai_pi
 repo_name: MaterDev/thepath-ai_pi
@@ -31,6 +33,8 @@ theme:
   font:
     text: Roboto
     code: Roboto Mono
+extra_css:
+  - stylesheets/extra.css
 markdown_extensions:
 - pymdownx.highlight:
     anchor_linenums: true
@@ -66,6 +70,7 @@ nav:
 - Overview:
   - Project Scope: overview/project-scope.md
   - Research Objectives: overview/research-objectives.md
+- AI Development Index: AI_DEVELOPMENT_INDEX.md
 - Logs:
   - Overview: meta/logs/index.md
   - January 17, 2025: meta/logs/2025-01-17.md
@@ -93,7 +98,6 @@ nav:
       - Communication: meta/phase1/3-communication.md
       - AI Integration: meta/phase1/4-ai-integration.md
       - Turn System: meta/phase1/5-turn-system.md
-  - AI Development Index: AI_DEVELOPMENT_INDEX.md
   - Style Guide: meta/style-guide.md
 - Technical:
   - Dependencies: technical/dependencies.md