9592971678
- Create api/swagger.md page to properly document Swagger UI access instead of linking raw swagger.json in mkdocs nav - Fix Stop() state management: properly set Running=false and cmd=nil on all exit paths, wait for process termination to avoid zombies 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
171 lines
4.1 KiB
YAML
171 lines
4.1 KiB
YAML
site_name: Mining - Cryptocurrency Mining Management
|
|
site_description: A modular cryptocurrency mining management system with CLI, API, and desktop applications
|
|
site_author: Mining Project Contributors
|
|
site_url: https://snider.github.io/Mining/
|
|
|
|
repo_name: Snider/Mining
|
|
repo_url: https://github.com/Snider/Mining
|
|
edit_uri: edit/main/docs/
|
|
|
|
docs_dir: docs
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
# Palette toggle for dark mode (default)
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: deep purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
# Palette toggle for light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: deep purple
|
|
accent: purple
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
|
|
features:
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.instant.progress
|
|
- navigation.tracking
|
|
- navigation.tabs
|
|
- navigation.tabs.sticky
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.path
|
|
- navigation.top
|
|
- navigation.footer
|
|
- toc.follow
|
|
- toc.integrate
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tabs.link
|
|
- content.action.edit
|
|
- content.action.view
|
|
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
edit: material/pencil
|
|
view: material/eye
|
|
|
|
font:
|
|
text: Roboto
|
|
code: Roboto Mono
|
|
|
|
plugins:
|
|
- search:
|
|
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
|
|
- git-revision-date-localized:
|
|
enable_creation_date: true
|
|
type: timeago
|
|
- minify:
|
|
minify_html: true
|
|
- glightbox:
|
|
touchNavigation: true
|
|
loop: false
|
|
effect: zoom
|
|
slide_effect: slide
|
|
width: 100%
|
|
height: auto
|
|
zoomable: true
|
|
draggable: true
|
|
|
|
markdown_extensions:
|
|
- abbr
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
toc_depth: 3
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets:
|
|
check_paths: true
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/github
|
|
link: https://github.com/Snider/Mining
|
|
- icon: fontawesome/brands/docker
|
|
link: https://hub.docker.com/r/snider/mining
|
|
generator: false
|
|
version:
|
|
provider: mike
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
copyright: Copyright © 2025 Mining Project Contributors
|
|
|
|
nav:
|
|
- Home: index.md
|
|
|
|
- Getting Started:
|
|
- Installation: getting-started/index.md
|
|
- Quick Start: getting-started/quick-start.md
|
|
|
|
- User Guide:
|
|
- CLI: user-guide/cli.md
|
|
- Web Dashboard: user-guide/web-dashboard.md
|
|
- Desktop App: user-guide/desktop-app.md
|
|
|
|
- API Reference:
|
|
- Overview: api/index.md
|
|
- Endpoints: api/endpoints.md
|
|
- Swagger Docs: api/swagger.md
|
|
|
|
- Development:
|
|
- Setup: development/index.md
|
|
- Architecture: development/architecture.md
|
|
- Contributing: development/contributing.md
|
|
|
|
- Reference:
|
|
- Mining Pools: reference/pools.md
|
|
- Algorithms: reference/algorithms.md
|
|
|
|
- Legacy Docs:
|
|
- Start Here: 00-START-HERE.md
|
|
- Quick Reference: QUICK-REFERENCE.md
|
|
- Pool Research: pool-research.md
|
|
- Pool Integration: pool-integration-guide.md
|
|
- Pool README: POOL-RESEARCH-README.md
|
|
- Files Index: FILES-INDEX.md
|
|
- Manifest: MANIFEST.md
|