Skip to content

Commit

Permalink
docs: update README and optimize cover image
Browse files Browse the repository at this point in the history
- Simplified README to focus on development utilities
- Reduced cover image size by 20%
- Added cover image to docs homepage
- Updated today's log with latest changes
- Improved image display with markdown syntax
  • Loading branch information
MaterDev committed Jan 17, 2025
1 parent cd83d2d commit 6563dc3
Show file tree
Hide file tree
Showing 18 changed files with 512 additions and 217 deletions.
226 changes: 42 additions & 184 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,210 +1,68 @@
# The Path (AI-Pi)

An edge AI-powered turn-based combat game running on Raspberry Pi hardware, demonstrating sophisticated AI behavior running entirely on local hardware.
> Edge AI game development on Raspberry Pi hardware
![Cover Image](images/cover.png)
![The Path (AI-Pi)](images/cover.png)

## Quick Links
📚 **[View Documentation](https://materdev.github.io/thepath-ai_pi/)**

- [Project Scope](docs/overview/project-scope.md)
- [AI Development Index](docs/AI_DEVELOPMENT_INDEX.md)
- [Development Logs](docs/meta/logs/index.md)
- [Setup Guide](docs/meta/implementation/setup/project-setup.md)
- [Contributing](docs/meta/contributing.md)
- [Style Guide](docs/meta/style-guide.md)
## Development

## Core Features
### Prerequisites
- Python 3.11+
- Raspberry Pi 5
- Make

### Edge AI Combat System
### Setup

- Real-time AI decision making (<100ms)
- Adaptive difficulty (0.2-0.95)
- Personality-based behavior
- Hardware acceleration
```bash
# Install dependencies
make setup

### Turn-Based Combat
# Run documentation locally
make docs

- Speed-based turn order
- Action point system
- Reaction mechanics
- Status effects

### Character System

- Six unique character classes
- Role-based gameplay mechanics
- Complementary team compositions
- Strategic counter-play system

### Character Classes

- **Conjuror**: Mid-range spell weaver focusing on damage and control
- **Crystal Vanguard**: Frontline protector with defensive capabilities
- **Zealot**: Aggressive skirmisher with high mobility
- **Wraithwood Seer**: Tactical support with control abilities
- **Primal Shifter**: Adaptable warrior with transformation powers
- **The Blessed**: Strategic enabler with utility and support

### Game Client

- Responsive UI (<16ms)
- Real-time updates
- Combat animations
- Touch support

## Getting Started

1. **Hardware Requirements**
- Raspberry Pi 5 (8GB RAM)
- AI HAT+ module
- Active cooling
- Optional: 7-inch touchscreen

2. **Quick Setup**
```bash
# Clone repository
git clone https://github.com/MaterDev/thepath-ai_pi.git
cd thepath-ai_pi

# Follow setup guide for detailed instructions
```

3. **Next Steps**
- Review [Project Setup](docs/meta/implementation/setup/project-setup.md)
- Install [Dependencies](docs/technical/dependencies.md)
- Configure [Hardware](docs/technical/hardware/configuration.md)

## Documentation Site

This project uses MkDocs with Material theme for documentation. To view the documentation locally:

1. **Install Dependencies**
```bash
pip install mkdocs-material
```

2. **Start Documentation Server**
```bash
mkdocs serve
```

3. **View Documentation**
- Open http://127.0.0.1:8000 in your browser
- Documentation will auto-reload when files change

4. **Build Static Site**
```bash
mkdocs build
```

The documentation site includes:
- Full-text search
- Dark/light mode
- Mobile-friendly design
- Auto-generated navigation
- Code syntax highlighting

## Development Timeline
# Update documentation
make update-docs
```

- **Phase 1 (Weeks 1-2)**: Core Systems
- Game state management
- WebSocket communication
- Basic AI integration
- Turn system
### Common Tasks

- **Phase 2 (Weeks 3-4)**: Game Features
- Combat mechanics
- Character system
- AI personalities
- Client UI
```bash
# Build project
make build

- **Phase 3 (Weeks 5-6)**: Polish & Launch
- Advanced features
- Performance optimization
- Testing & validation
- Release preparation
# Run tests
make test

See [Project Scope](docs/overview/project-scope.md) for detailed timeline.
# Clean build artifacts
make clean

## Technical Stack
# Deploy documentation
make deploy-docs
```

### Server (Go 1.21+)
- Game state management
- WebSocket communication
- Performance optimization
- State serialization
### Documentation Updates

### Client (TypeScript/React)
- User interface
- State management
- Network layer
- Animations

### AI System (Python 3.11+)
- Behavior models
- Training pipeline
- Difficulty system
- Hardware acceleration
The documentation is automatically updated and deployed via GitHub Actions when changes are pushed to the main branch.

## AI-First Development Approach

This project uses a unique methodology designed for agentic IDE tools like Windsurf, focusing on comprehensive documentation as a framework for AI-assisted development.
To update locally:
1. Install documentation dependencies: `pip install -r docs/requirements.txt`
2. Run local server: `mkdocs serve`
3. View at: `http://localhost:8000`

### Documentation Structure
## Project Structure

```
docs/
├── AI_DEVELOPMENT_INDEX.md # Master reference for AI tools
├── overview/ # High-level documentation
├── implementation/ # Implementation details
├── technical/ # Technical specifications
└── meta/ # Project metadata
.
├── docs/ # Documentation
├── scripts/ # Utility scripts
├── src/ # Source code
├── tests/ # Test files
├── Makefile # Build automation
└── mkdocs.yml # Documentation config
```

### Key Components

1. **AI Development Index**
- Master reference document
- Critical specifications
- Implementation guidance
- Documentation updates

2. **Project Scope**
- Detailed timeline
- Task dependencies
- Implementation priorities
- Success criteria

3. **Technical Specifications**
- API definitions
- Data schemas
- Performance requirements
- Hardware configurations

### Benefits

1. **Enhanced AI Development**
- Consistent context
- Clear specifications
- Reduced errors
- Faster development

2. **Project Coherence**
- Maintained standards
- Clear dependencies
- Tracked progress
- Quality assurance

## Research Focus

The project explores:
- Edge AI optimization
- Hardware acceleration
- Adaptive gameplay
- Player interaction patterns

See [Research Objectives](docs/overview/research-objectives.md) for details.

## License

This project is licensed under the Mater Development General Use License (MDGUL) v1.1.
Expand Down
Binary file added docs/images/cover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 9 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# The Path (AI-Pi)

An edge AI-powered turn-based combat game running on Raspberry Pi hardware, demonstrating sophisticated AI behavior running entirely on local hardware.
![The Path (AI-Pi)](images/cover.png)

> Pushing the boundaries of edge AI gaming on Raspberry Pi hardware.
Welcome to The Path (AI-Pi) documentation. This site contains comprehensive information about the project, including technical details, setup guides, development logs, and research objectives.

## Quick Links

Expand Down Expand Up @@ -36,3 +40,7 @@ An edge AI-powered turn-based combat game running on Raspberry Pi hardware, demo
- [Development Logs](meta/logs/index.md)
- [Contributing](meta/contributing.md)
- [Style Guide](meta/style-guide.md)

## Latest Updates

Check our [development logs](meta/logs/index.md) for the most recent changes and [social updates](meta/social/index.md) for project announcements.
53 changes: 51 additions & 2 deletions docs/meta/logs/2025-01-17.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
## Session Overview
```yaml
type: Documentation and Infrastructure
duration: 2 hours
hashtags: [github-pages, documentation, theme-configuration, ci-cd, workflow-setup]
duration: 3.5 hours
hashtags: [github-pages, documentation, theme-configuration, ci-cd, workflow-setup, social-media, readme]
blockers: None
```
Expand All @@ -14,6 +14,9 @@ blockers: None
* Documentation theme configuration
* CI/CD workflow implementation
* Logging system automation
* Social media updates documentation
* README simplification
* Cover image optimization
## Changes Made
Expand Down Expand Up @@ -49,6 +52,42 @@ blockers: None
* Set up proper dependency installation
* Added error handling and build verification
### Social Media Documentation
* Created new section for social media updates
* Organized LinkedIn posts chronologically (December 2024 - January 2025)
* Implemented consistent formatting:
- YAML frontmatter for metadata
- Plain text code blocks for post content
- Preserved original formatting and emojis
* Added proper hashtag formatting
* Structured posts in individual date-based files
* Added section to navigation after development logs
* Created new post announcing documentation site launch
### Documentation Update Script
* Enhanced update_logs.py to handle both logs and social media posts
* Added support for nested navigation sections
* Maintained chronological ordering for all dated content
* Improved error handling and section management
### Cover Image Updates
* Reduced cover.png size by 20% for better performance
* Added cover image to root README using markdown syntax
* Added cover image to documentation homepage
* Created docs/images directory for documentation assets
* Ensured consistent image display across platforms
### README Simplification
* Streamlined root-level README to focus on development utilities
* Moved project details to documentation site
* Added clear documentation site link
* Documented Makefile commands and project structure
* Improved setup and development instructions
## Technical Details
### Key Configuration Changes
Expand Down Expand Up @@ -92,6 +131,14 @@ theme:
- Issue: Initial deployment failing due to permission issues
- Solution: Added proper GitHub Pages permissions and environment setup
4. **Social Media Documentation**
- Issue: Inconsistent formatting in social media posts
- Solution: Standardized format with YAML metadata and code blocks
5. **Documentation Organization**
- Issue: Complex navigation structure with multiple sections
- Solution: Enhanced update script to handle nested sections
## Next Steps
* Monitor GitHub Pages deployment for any issues
Expand All @@ -101,6 +148,8 @@ theme:
- PDF export
- Site analytics
* Implement automated testing for documentation changes
* Consider adding more social media platforms as needed
* Continue improving documentation organization
## Resources
Expand Down
4 changes: 4 additions & 0 deletions docs/meta/social/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
title: Social Media Updates
arrange:
- index.md
- ...
27 changes: 27 additions & 0 deletions docs/meta/social/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Social Media Updates

This section contains an archive of social media posts about The Path (AI-Pi) project. These posts provide insights into the project's development journey and public communication.

## Post Categories

* LinkedIn Updates - Professional updates and technical insights
* Development Announcements - Major milestone announcements
* Technical Discussions - Detailed technical posts about the project

## Purpose

These posts serve multiple purposes:

1. Document the public communication history
2. Track project milestone announcements
3. Maintain consistency in project messaging
4. Provide context for project evolution

## Organization

Posts are organized chronologically and include:
- Original post date
- Platform
- Content
- Links (if any)
- Hashtags used
Loading

0 comments on commit 6563dc3

Please sign in to comment.