docs: added documentation creation framework

[thecodacus]

Add MkDocs Documentation Infrastructure

Overview

This PR introduces comprehensive documentation infrastructure using MkDocs Material theme. We're setting up automated documentation deployment through GitHub Actions while preserving existing content as the foundation for our new documentation system.

Key Changes

Documentation Structure

• Established a new /docs directory with a clear hierarchical structure
• Migrated existing documentation content, preserving the valuable information while organizing it better
• Created initial documentation pages including:
  • Main landing page with project overview
  • Contributing guidelines with detailed setup instructions
  • FAQ section addressing common questions

Technical Implementation

• Configured MkDocs Material theme with responsive design and dark mode support
• Set up GitHub Actions workflow for automatic documentation deployment
• Added proper caching mechanisms in the CI pipeline for faster builds
• Integrated Poetry for Python dependency management in the documentation system

Build and Deployment

• Added new GitHub Actions workflow (docs.yaml) that:
  • Triggers on main branch pushes and pull requests
  • Uses GitHub Actions bot for commits
  • Implements caching for build optimization
  • Automatically deploys to GitHub Pages

Configuration

• Added comprehensive MkDocs configuration (mkdocs.yml) with:
  • Material theme customization
  • Navigation structure
  • Search functionality
  • Code syntax highlighting
  • Responsive design settings

Dependencies

• Added Poetry configuration for documentation dependencies
• Included necessary Python packages for documentation building
• Set up proper dependency management through pyproject.toml

Impact

• Provides a maintainable and scalable documentation system
• Improves developer experience with better organized documentation
• Enables automatic deployment of documentation updates
• Facilitates contribution by providing clear guidelines
• Enhances project professionalism with well-structured docs

Testing

• Verified local documentation build process
• Confirmed proper rendering of all documentation pages
• Validated responsive design across different devices

Future Improvements

• Include API documentation generation
• Add more interactive examples and tutorials

Preview

https://thecodacus.github.io/dash-ai/

[wonderwhy-er]

Seems like action fails?
https://github.com/coleam00/bolt.new-any-llm/pull/445/checks

[thecodacus]

Seems like action fails? https://github.com/coleam00/bolt.new-any-llm/pull/445/checks

this needs permission to run the github action to publish a new branch in the repo for github pages. As this is still not merged with the repo the action will not work.