Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/docs
History
Exact
Snider 9dbcf7885c feat: Enhance dashboard layout with responsive stats bar and chart integration
2025-12-11 16:04:17 +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: Enhance dashboard layout with responsive stats bar and chart integration 2025-12-11 16:04:17 +00:00
README.md Add descriptive markdown documentation to docs folder 2025-11-25 00:03:35 +00:00
swagger.json feat: Enhance dashboard layout with responsive stats bar and chart integration 2025-12-11 16:04:17 +00:00
swagger.yaml feat: Enhance dashboard layout with responsive stats bar and chart integration 2025-12-11 16:04:17 +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.