Commit Graph

41 Commits

Author SHA1 Message Date
jango-blockchained
61e930bf8a docs: Refactor documentation structure and enhance project overview
- Update MkDocs configuration with streamlined navigation and theme improvements
- Revise README with comprehensive project introduction and key features
- Add new documentation pages for NLP, custom prompts, and extras
- Enhance index page with system architecture diagram and getting started guide
- Improve overall documentation clarity and organization
2025-02-06 10:06:27 +01:00
jango-blockchained
4db60b6a6f docs: Update environment configuration and README with comprehensive setup guide
- Enhance `.env.example` with more detailed and organized configuration options
- Refactor README to provide clearer setup instructions and system architecture overview
- Add new `scripts/setup-env.sh` for flexible environment configuration management
- Update `docs/configuration.md` with detailed environment loading strategy and best practices
- Improve documentation for speech features, client integration, and development workflows
2025-02-06 09:35:02 +01:00
jango-blockchained
69e9c7de55 refactor: Enhance environment configuration and loading mechanism
- Implement flexible environment variable loading strategy
- Add support for environment-specific and local override configuration files
- Create new `loadEnv.ts` module for dynamic environment configuration
- Update configuration loading in multiple config files
- Remove deprecated `.env.development.template`
- Add setup script for environment validation
- Improve WebSocket error handling and client configuration
2025-02-06 08:55:23 +01:00
jango-blockchained
cc9eede856 docs: Add comprehensive speech features documentation and configuration
- Introduce detailed documentation for speech processing capabilities
- Add new speech features documentation in `docs/features/speech.md`
- Update README with speech feature highlights and prerequisites
- Expand configuration documentation with speech-related settings
- Include model selection, GPU acceleration, and best practices guidance
2025-02-06 04:30:20 +01:00
jango-blockchained
f0ff3d5e5a docs: Update configuration documentation to use environment variables
- Migrate from YAML configuration to environment-based configuration
- Add detailed explanations for new environment variable settings
- Include best practices for configuration management
- Enhance logging and security configuration documentation
- Add examples for log rotation and rate limiting
2025-02-06 04:25:35 +01:00
jango-blockchained
81d6dea7da docs: Restructure documentation and enhance configuration
- Reorganize MkDocs navigation structure with new sections
- Add configuration, security, and development environment documentation
- Remove outdated development and getting started files
- Update requirements and plugin configurations
- Improve overall documentation layout and content
2025-02-06 04:11:16 +01:00
jango-blockchained
6fa88be433 docs: Enhance MkDocs configuration with advanced features and styling
- Upgrade MkDocs Material theme with modern navigation and UI features
- Add comprehensive markdown extensions and plugin configurations
- Introduce new JavaScript and CSS for improved documentation experience
- Update documentation requirements with latest plugin versions
- Implement dark mode enhancements and code block improvements
- Expand navigation structure and add new documentation sections
2025-02-06 04:00:27 +01:00
jango-blockchained
2892f24030 docs: Revert to standard git revision date plugin
- Replace mkdocs-git-revision-date-localized-plugin with mkdocs-git-revision-date-plugin
- Update plugin configuration in mkdocs.yml
- Modify documentation requirements to use standard revision date plugin
2025-02-05 23:56:08 +01:00
jango-blockchained
1e3442db14 docs: Update git revision date plugin to localized version
- Replace mkdocs-git-revision-date-plugin with mkdocs-git-revision-date-localized-plugin
- Update plugin version in mkdocs.yml configuration
- Upgrade plugin version in documentation requirements
2025-02-05 23:48:12 +01:00
jango-blockchained
f74154d96f docs: Disable social cards and pin social plugin version
- Modify MkDocs configuration to disable social cards
- Pin mkdocs-social-plugin to version 0.1.0 in requirements
- Prevent potential issues with social card generation
2025-02-05 23:41:08 +01:00
jango-blockchained
36d83e0a0e docs: Update MkDocs documentation configuration and dependencies
- Modify mkdocstrings plugin configuration to use default Python handler
- Update documentation requirements to include mkdocstrings-python
- Simplify MkDocs plugin configuration for documentation generation
2025-02-05 23:38:17 +01:00
jango-blockchained
4306a6866f docs: Simplify documentation site configuration and deployment
- Streamline MkDocs navigation structure
- Reduce complexity in GitHub Actions documentation workflow
- Update documentation dependencies and requirements
- Simplify site name and deployment configuration
2025-02-05 23:29:50 +01:00
jango-blockchained
039f6890a7 housekeeping 2025-02-05 23:24:26 +01:00
jango-blockchained
4fff318ea9 docs: Enhance documentation deployment and site configuration
- Update MkDocs configuration with new features and plugins
- Add deployment guide for documentation
- Restructure documentation navigation and index page
- Create GitHub Actions workflow for automatic documentation deployment
- Fix typos in site URLs and configuration
2025-02-05 21:07:39 +01:00
jango-blockchained
13a27e1d00 docs: update MkDocs configuration and documentation structure
- Refactor mkdocs.yml with new project name and simplified configuration
- Update GitHub Actions workflow to use MkDocs Material deployment
- Add new configuration files for Claude Desktop
- Reorganize documentation navigation and structure
- Update CSS and JavaScript references
2025-02-05 12:44:26 +01:00
jango-blockchained
3e7f3920b2 docs: update project documentation with simplified, focused content
- Streamline README, API, architecture, and usage documentation
- Reduce complexity and focus on core functionality
- Update roadmap with more pragmatic, near-term goals
- Simplify contributing guidelines
- Improve overall documentation clarity and readability
2025-02-05 10:40:27 +01:00
jango-blockchained
eefbf790c3 test: migrate test suite from Jest to Bun test framework
- Convert test files to use Bun's test framework and mocking utilities
- Update import statements and test syntax
- Add comprehensive test utilities and mock implementations
- Create test migration guide documentation
- Implement helper functions for consistent test setup and teardown
- Add type definitions for improved type safety in tests
2025-02-05 04:41:13 +01:00
jango-blockchained
a1cc54f01f docs: reorganize SSE API documentation and update navigation
- Move SSE API documentation to a more structured location under `api/`
- Update references to SSE API in getting started and navigation
- Remove standalone SSE API markdown file
- Add FAQ section to troubleshooting documentation
2025-02-05 03:07:22 +01:00
jango-blockchained
e3256682ba docs: expand documentation with comprehensive tools and development guides
- Add detailed documentation for various tools and management interfaces
- Create development best practices and interface documentation
- Expand tools section with device management, automation, and event subscription guides
- Include configuration, usage examples, and error handling for each tool
- Update MkDocs navigation to reflect new documentation structure
2025-02-05 03:02:17 +01:00
jango-blockchained
7635cce15a docs: expand documentation with new sections and deployment guides
- Add Examples section to MkDocs navigation
- Create initial Examples overview page with placeholder content
- Add Docker deployment guide to Getting Started section
- Update installation documentation with Smithery configuration details
2025-02-05 02:46:43 +01:00
jango-blockchained
53a041921b docs: enhance documentation with comprehensive API, architecture, and installation guides
- Add detailed API documentation for core functions, SSE, and WebSocket APIs
- Create comprehensive architecture overview with system design diagrams
- Develop in-depth installation and quick start guides
- Improve troubleshooting documentation with advanced debugging techniques
- Update site navigation and markdown configuration
2025-02-05 02:44:30 +01:00
jango-blockchained
af3399515a docs: enhance documentation site with improved design and features
- Update MkDocs configuration with advanced theme settings
- Add custom color palette and navigation features
- Expand markdown extensions for better documentation rendering
- Include new documentation sections and plugins
- Add custom CSS for improved site styling
- Update site description and navigation structure
2025-02-05 02:33:05 +01:00
jango-blockchained
ab8b597843 docs: add MCP client integration documentation and scripts
- Update README with integration instructions for Cursor, Claude Desktop, and Cline
- Add configuration examples for different MCP client integrations
- Create Windows CMD script for starting MCP server
- Include configuration files for Claude Desktop and Cline clients
2025-02-05 00:48:45 +01:00
jango-blockchained
dfff432321 docs: update Jekyll configuration for GitHub Pages and dependencies
- Add repository settings and GitHub metadata plugin
- Update baseurl to match repository name
- Include additional Jekyll and Ruby dependencies in Gemfile
- Simplify configuration by removing redundant sections
2025-02-04 18:00:59 +01:00
jango-blockchained
d59bf02d08 docs: enhance Jekyll configuration with comprehensive site settings
- Add base URL and site configuration for GitHub Pages
- Include remote theme and additional Jekyll plugins
- Configure navigation structure and page layouts
- Set up collections for tools and development sections
- Optimize Gemfile with additional dependencies
2025-02-04 17:58:10 +01:00
jango-blockchained
345a5888d9 docs: update Jekyll configuration for enhanced documentation structure
- Add new documentation pages to header navigation
- Configure collections for tools and development sections
- Set default layouts for pages, tools, and development collections
- Improve documentation site organization and navigation
2025-02-04 17:51:04 +01:00
jango-blockchained
d6a5771e01 docs: enhance project documentation with comprehensive updates
- Revamp README.md with improved project overview, architecture diagram, and badges
- Create new development and tools documentation with detailed guides
- Update API documentation with enhanced examples, rate limiting, and security information
- Refactor and consolidate documentation files for better navigation and clarity
- Add emojis and visual improvements to make documentation more engaging
2025-02-04 17:49:58 +01:00
jango-blockchained
5f4ddfbd88 docs: add GitHub Pages documentation deployment workflow
- Create GitHub Actions workflow for deploying documentation to GitHub Pages
- Update README.md with documentation badge and link
- Add missing gem dependency in docs/Gemfile
- Configure Jekyll build and deployment process
2025-02-04 17:37:20 +01:00
jango-blockchained
3a54766b61 docs: refactor and improve documentation across multiple files
- Streamline and enhance documentation for API, architecture, getting started, and usage
- Improve clarity, readability, and organization of documentation files
- Update content to be more concise and informative
- Ensure consistent formatting and style across documentation
2025-02-04 17:33:26 +01:00
jango-blockchained
8b1948ce30 docs: enhance documentation structure and add project roadmap
- Refactor index.md with improved navigation and comprehensive documentation sections
- Update README.md to streamline documentation navigation
- Create new roadmap.md with detailed project goals and vision
- Add testing.md with comprehensive testing guidelines and best practices
- Improve overall documentation clarity and user experience
2025-02-04 17:25:32 +01:00
jango-blockchained
38ee5368d1 docs: update acronym
- Rename MCP acronym in documentation and package files
- Update site name, package description, and documentation references
- Ensure consistent terminology across project files
2025-02-04 17:19:58 +01:00
jango-blockchained
b0ad1cf0ad docs: add comprehensive documentation for MCP project
- Create comprehensive documentation structure using MkDocs
- Add markdown files for API reference, architecture, getting started, and troubleshooting
- Configure GitHub Pages deployment workflow
- Include custom Jekyll and MkDocs configurations
- Add custom styling and layout for documentation site
2025-02-04 17:14:39 +01:00
jango-blockchained
5f078ff227 docs: update environment variable naming from NODE_ENV to BUN_ENV 2025-02-04 14:56:22 +01:00
jango-blockchained
02284c787b docs: add contributing guidelines and project roadmap
- Create CONTRIBUTING.md with comprehensive guidelines for community contributions
- Develop ROADMAP.md outlining near-term, mid-term, and long-term project goals
- Provide clear instructions for code style, testing, and community engagement
- Define project vision and future enhancement strategies
2025-02-04 04:28:26 +01:00
jango-blockchained
3e97357561 docs: update documentation to use Bun commands and scripts
- Replace npm commands with equivalent Bun commands in GETTING_STARTED.md
- Update TESTING.md to reflect Bun-specific test and development scripts
- Simplify installation, development, and testing instructions
2025-02-04 04:17:58 +01:00
jango-blockchained
cb897d4cf6 docs: add comprehensive architecture documentation for MCP Server
- Create ARCHITECTURE.md with detailed system design overview
- Describe key architectural components including Bun runtime, SSE communication, and modular design
- Highlight security, performance, and scalability features
- Outline future enhancement roadmap
- Provide insights into system design principles and technology choices
2025-02-04 04:14:43 +01:00
jango-blockchained
790a37e49f refactor: migrate to Elysia and enhance security middleware
- Replaced Express with Elysia for improved performance and type safety
- Integrated Elysia middleware for rate limiting, security headers, and request validation
- Refactored security utilities to work with Elysia's context and request handling
- Updated token management and validation logic
- Added comprehensive security headers and input sanitization
- Simplified server initialization and error handling
- Updated documentation with new setup and configuration details
2025-02-04 03:09:35 +01:00
jango-blockchained
18f09bb5ce Add comprehensive documentation for Home Assistant MCP project
- Created detailed getting started guide with installation and configuration instructions
- Added main documentation README with structured table of contents
- Developed troubleshooting guide with common issues, debugging tips, and FAQ
- Included development guide with project structure, setup, and contribution guidelines
- Added tools documentation with overview of available management tools
2025-02-03 15:38:55 +01:00
jango-blockchained
cb6b16546b Refactor API Documentation with Comprehensive MCP Schema and Endpoint Details
- Completely restructured API.md with a more modular and detailed approach
- Added comprehensive schema documentation for MCP endpoint
- Expanded sections on device control, add-on management, and core functions
- Included WebSocket event handling and real-time update mechanisms
- Enhanced error handling and rate limiting documentation
- Added example usage sections with curl and JavaScript demonstrations
- Improved overall readability and technical depth of API reference
2025-02-03 00:28:07 +01:00
jango-blockchained
e1e0a45acc Add Server-Sent Events (SSE) API documentation and README updates
- Created comprehensive SSE API documentation in `docs/SSE_API.md`
- Updated README.md with new features section highlighting SSE capabilities
- Added `.cursornotes` file for SSE subscription flow
- Provided detailed examples and usage guidelines for SSE integration
- Documented event types, authentication, and best practices for real-time updates
2025-01-30 12:21:25 +01:00
jango-blockchained
70c9287c68 Add comprehensive Home Assistant MCP API documentation
- Created detailed API documentation for Home Assistant Model Context Protocol (MCP)
- Documented authentication, rate limiting, and security best practices
- Included comprehensive endpoint descriptions for:
  * Natural Language Processing
  * Device Control
  * History
  * Scenes
  * Automations
  * Add-ons
  * Package Management
- Added WebSocket event handling and connection examples
- Provided error handling and response format guidelines
2025-01-30 11:04:21 +01:00