Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Mining/docs/README.md
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

867 B
Raw Blame History

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.