docs

README

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.

Documentation

Overview

Package docs Code generated by swaggo/swag. DO NOT EDIT

Index

• Variables

Variables

var SwaggerInfo = &swag.Spec{
	Version:          "1.0",
	Host:             "localhost:8080",
	BasePath:         "/api/v1/mining",
	Schemes:          []string{},
	Title:            "Mining API",
	Description:      "This is a sample server for a mining application.",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
	LeftDelim:        "{{",
	RightDelim:       "}}",
}

SwaggerInfo holds exported Swagger Info so clients can modify it