960ae087fa
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.
14 lines
867 B
Markdown
14 lines
867 B
Markdown
# 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**](API.md): Detailed information about the RESTful API endpoints, request/response formats, and Swagger usage.
|
|
- [**CLI Documentation**](CLI.md): A comprehensive guide to the Command Line Interface, including command descriptions and usage examples.
|
|
- [**Architecture Guide**](ARCHITECTURE.md): An overview of the project's design, including the modular `ManagerInterface`, core packages, and data flow.
|
|
- [**Development Guide**](DEVELOPMENT.md): 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](../README.md) in the project root.
|