82 lines
2.4 KiB
Markdown
82 lines
2.4 KiB
Markdown
# SPORE Documentation
|
|
|
|
This folder contains comprehensive documentation for the SPORE embedded system.
|
|
|
|
## Available Documentation
|
|
|
|
### 📖 [API.md](./API.md)
|
|
Complete API reference with detailed endpoint documentation, examples, and integration guides.
|
|
|
|
**Includes:**
|
|
- API endpoint specifications
|
|
- Request/response examples
|
|
- HTTP status codes
|
|
- Integration examples (Python, JavaScript)
|
|
- Task management workflows
|
|
- Cluster monitoring examples
|
|
|
|
### 📖 [MonitoringService.md](./MonitoringService.md)
|
|
System resource monitoring API for CPU, memory, filesystem, and uptime.
|
|
|
|
### 📖 [TaskManagement.md](./TaskManagement.md)
|
|
Complete guide to the task management system with examples and best practices.
|
|
|
|
**Includes:**
|
|
- Task registration methods (std::bind, lambdas, functions)
|
|
- Task control and lifecycle management
|
|
- Remote task management via API
|
|
- Performance considerations and best practices
|
|
- Migration guides and compatibility information
|
|
|
|
### 📖 [Architecture.md](./Architecture.md)
|
|
Comprehensive system architecture and implementation details.
|
|
|
|
**Includes:**
|
|
- Core component descriptions
|
|
- Auto discovery protocol details
|
|
- Task scheduling system
|
|
- Event system architecture
|
|
- Resource monitoring
|
|
- Performance characteristics
|
|
- Security and scalability considerations
|
|
|
|
### 📖 [Development.md](./Development.md)
|
|
Complete development and deployment guide.
|
|
|
|
**Includes:**
|
|
- PlatformIO configuration
|
|
- Filesystem, linker scripts, and flash layout mapping
|
|
- Build and flash instructions
|
|
- OTA update procedures
|
|
- Cluster management commands
|
|
- Development workflow
|
|
- Troubleshooting guide
|
|
- Best practices
|
|
|
|
### 📖 [StaticFileService.md](./StaticFileService.md)
|
|
Static file hosting over HTTP using LittleFS.
|
|
|
|
## Quick Links
|
|
|
|
- **Main Project**: [../README.md](../README.md)
|
|
- **OpenAPI Specification**: [../api/](../api/)
|
|
- **Source Code**: [../src/](../src/)
|
|
|
|
## Contributing
|
|
|
|
When adding new documentation:
|
|
|
|
1. Create a new `.md` file in this folder
|
|
2. Use clear, descriptive filenames
|
|
3. Include practical examples and code snippets
|
|
4. Update this README.md to reference new files
|
|
5. Follow the existing documentation style
|
|
|
|
## Documentation Style Guide
|
|
|
|
- Use clear, concise language
|
|
- Include practical examples
|
|
- Use code blocks with appropriate language tags
|
|
- Include links to related documentation
|
|
- Use emojis sparingly for visual organization
|
|
- Keep README.md files focused and scoped |