History

google-labs-jules[bot] 960ae087fa Add descriptive markdown documentation to docs folder Added comprehensive documentation including: - API.md: REST API reference. - CLI.md: Command Line Interface usage. - ARCHITECTURE.md: System design and components. - DEVELOPMENT.md: Developer guide. - README.md: Index for the documentation.		2025-11-25 00:03:35 +00:00
..
API.md	Add descriptive markdown documentation to docs folder	2025-11-25 00:03:35 +00:00
ARCHITECTURE.md	Add descriptive markdown documentation to docs folder	2025-11-25 00:03:35 +00:00
CLI.md	Add descriptive markdown documentation to docs folder	2025-11-25 00:03:35 +00:00
DEVELOPMENT.md	Add descriptive markdown documentation to docs folder	2025-11-25 00:03:35 +00:00
docs.go	adds historial hashrate data that reduces from 10s res to 1m res after a rolling 5m window.	2025-11-09 04:08:10 +00:00
README.md	Add descriptive markdown documentation to docs folder	2025-11-25 00:03:35 +00:00
swagger.json	adds historial hashrate data that reduces from 10s res to 1m res after a rolling 5m window.	2025-11-09 04:08:10 +00:00
swagger.yaml	adds historial hashrate data that reduces from 10s res to 1m res after a rolling 5m window.	2025-11-09 04:08:10 +00:00

README.md

Mining Documentation

Welcome to the documentation for the Mining project. This folder contains detailed information about the API, CLI, architecture, and development processes.

Documentation Index

API Documentation: Detailed information about the RESTful API endpoints, request/response formats, and Swagger usage.
CLI Documentation: A comprehensive guide to the Command Line Interface, including command descriptions and usage examples.
Architecture Guide: An overview of the project's design, including the modular ManagerInterface, core packages, and data flow.
Development Guide: Instructions for contributors on how to build, test, and release the project.

Quick Start

For a quick start guide, please refer to the main README.md in the project root.