Mining/docs
2025-12-29 22:10:45 +00:00
..
00-START-HERE.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +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 feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
FILES-INDEX.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
MANIFEST.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
pool-integration-guide.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
POOL-RESEARCH-README.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
pool-research.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
QUICK-REFERENCE.md feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
README.md Add descriptive markdown documentation to docs folder 2025-11-25 00:03:35 +00:00
RESEARCH-SUMMARY.txt feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00
swagger.json feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
swagger.yaml feat: Implement logging functionality for miners with log buffer and retrieval endpoint 2025-12-29 22:10:45 +00:00
xmr-pools-database.json feat: Add multi-miner dashboard support and TT-Miner implementation 2025-12-27 22:48:20 +00:00

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.