From 98cffed540e315425ef018607049eafd6e0dd769 Mon Sep 17 00:00:00 2001 From: Key Clark Date: Tue, 21 Jan 2025 00:48:49 -0600 Subject: [PATCH] docs: update mkdocs site structure - Add World section with cultural foundations - Streamline navigation hierarchy - Update theme configuration - Clean up markdown extensions --- mkdocs.yml | 118 +++++++++++++++++++---------------------------------- 1 file changed, 42 insertions(+), 76 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index d573299..45eab2b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ site_name: The Path (AI-Pi) -site_description: Edge AI-powered turn-based combat game running on Raspberry Pi hardware. +site_description: Documentation for The Path (AI-Pi) project site_author: MaterDev site_url: https://materdev.github.io/thepath-ai_pi/ repo_url: https://github.com/MaterDev/thepath-ai_pi @@ -7,44 +7,44 @@ repo_name: MaterDev/thepath-ai_pi theme: name: material features: - - navigation.tabs - - navigation.sections - - navigation.expand - - navigation.indexes - navigation.instant - navigation.tracking - - toc.follow + - navigation.sections + - navigation.expand + - navigation.top - search.suggest - search.highlight - - navigation.tabs.sticky palette: - - scheme: slate + - scheme: default primary: indigo accent: indigo toggle: icon: material/brightness-7 - name: Switch to light mode - - scheme: default + name: Switch to dark mode + - scheme: slate primary: indigo accent: indigo toggle: icon: material/brightness-4 - name: Switch to dark mode + name: Switch to light mode font: text: Roboto code: Roboto Mono extra_css: - stylesheets/extra.css markdown_extensions: +- admonition +- pymdownx.details +- pymdownx.superfences +- attr_list +- md_in_html +- pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg - pymdownx.highlight: anchor_linenums: true - line_spans: __span - pygments_lang_class: true - pymdownx.inlinehilite - pymdownx.snippets -- pymdownx.superfences -- admonition -- pymdownx.details - pymdownx.tabbed: alternate_style: true - tables @@ -54,9 +54,6 @@ markdown_extensions: - pymdownx.keys - pymdownx.mark - pymdownx.tilde -- attr_list -- def_list -- md_in_html - toc: permalink: true title: On this page @@ -67,63 +64,32 @@ docs_dir: docs site_dir: site nav: - Home: index.md -- Overview: - - Project Scope: overview/project-scope.md - - Research Objectives: overview/research-objectives.md -- Logs: - - Overview: meta/logs/index.md - - January 19, 2025: meta/logs/2025-01-19.md - - January 17, 2025: meta/logs/2025-01-17.md - - January 15, 2025: meta/logs/2025-01-15.md - - January 13, 2025: meta/logs/2025-01-13.md - - January 09, 2025: meta/logs/2025-01-09.md - - January 08, 2025: meta/logs/2025-01-08.md -- Social Updates: - - Overview: meta/social/index.md - - LinkedIn: - - Overview: meta/social/linkedin/index.md - - January 19, 2025: meta/social/linkedin/2025-01-19.md - - January 17, 2025: meta/social/linkedin/2025-01-17.md - - January 14, 2025: meta/social/linkedin/2025-01-14.md - - January 08, 2025: meta/social/linkedin/2025-01-08.md - - January 07, 2025: meta/social/linkedin/2025-01-07.md - - January 03, 2025: meta/social/linkedin/2025-01-03.md - - December 27, 2024: meta/social/linkedin/2024-12-27.md -- AI Development Index: AI_DEVELOPMENT_INDEX.md -- Technical: - - Setup: - - Docker: technical/setup/docker.md - - AI System: - - Behavior Model: technical/ai-system/behavior-model.md - - Difficulty System: technical/ai-system/difficulty-system.md - - Training Pipeline: technical/ai-system/training-pipeline.md - - Data Schemas: - - Game State: technical/data-schemas/game-state.md - - AI Models: technical/data-schemas/ai-models.md - - Replay System: technical/data-schemas/replay-system.md - - Hardware: - - Raspberry Pi 5: technical/hardware/raspberry-pi-5.md - - AI HAT Plus: technical/hardware/ai-hat-plus.md - - Health Monitoring: - - Overview: technical/health/index.md - - Client: technical/health/client.md - - Server: technical/health/server.md - - AI System: technical/health/ai.md - - Client: - - UI Specification: technical/client/ui-specification.md -- Development: - - Setup: meta/implementation/setup/project-setup.md - - Planning: - - Phase 1: - - Overview: meta/phase1/index.md - - Project Setup: meta/phase1/1-project-setup.md - - Game State: meta/phase1/2-game-state.md - - Communication: meta/phase1/3-communication.md - - AI Integration: meta/phase1/4-ai-integration.md - - Turn System: meta/phase1/5-turn-system.md - - Style Guide: meta/style-guide.md +- World: + - Cultural Foundations: world/cultural_foundations.md - Combat System: - Overview: combat_system/balance_and_meta.md - Character Classes: combat_system/classes.md -- World: - - Cultural Foundations: world/cultural_foundations.md +- Implementation: + - Setup: + - Project Setup: implementation/setup/project-setup.md + - Development Environment: implementation/setup/development-environment.md + - Architecture: + - System Design: implementation/architecture/system-design.md + - Data Flow: implementation/architecture/data-flow.md + - AI: + - Overview: implementation/ai/overview.md + - Models: implementation/ai/models.md + - Training: implementation/ai/training.md + - Hardware: + - Requirements: implementation/hardware/requirements.md + - Optimization: implementation/hardware/optimization.md +- Meta: + - Development Guidelines: meta/development-guidelines.md + - Documentation Standards: meta/documentation-standards.md + - Style Guide: meta/style-guide.md + - Analysis: + - Documentation Analysis: meta/analysis/documentation-analysis.md + - Logs: + - 2025-01-13: meta/logs/2025-01-13.md + - 2025-01-09: meta/logs/2025-01-09.md +- AI Development Index: AI_DEVELOPMENT_INDEX.md