mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-04-26 19:05:17 +00:00
agessaman
d15c58994e
- Deleted COMMANDS.md, DOCKER.md, WEB_VIEWER.md, and other related documentation files to streamline the project structure. - Updated README.md and other documentation references to point to the new locations of the command and Docker instructions. - Added optional dependencies for documentation generation in pyproject.toml.
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# meshcore-bot Documentation
|
||
|
||
Documentation for the MeshCore bot: setup, configuration, commands, and services.
|
||
|
||
**New to the project?** Start with [Getting Started](getting-started.md).
|
||
|
||
## Project overview
|
||
|
||
- [README](https://github.com/agessaman/meshcore-bot/blob/main/README.md) – Getting started, installation, quick start
|
||
- [Command Reference](COMMANDS.md) – Full command reference
|
||
- [Docker deployment](DOCKER.md) – Docker deployment
|
||
- [SERVICE-INSTALLATION.md](https://github.com/agessaman/meshcore-bot/blob/main/SERVICE-INSTALLATION.md) – Systemd service setup
|
||
- [Web Viewer](WEB_VIEWER.md) – Web viewer module
|
||
|
||
## Configuration
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [Configuration](configuration.md) | config.ini structure and command options |
|
||
| [Path Command](PATH_COMMAND_CONFIG.md) | Path command presets and tuning |
|
||
|
||
## Guides
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [Repeater Commands](REPEATER_COMMANDS.md) | Repeater management DM commands |
|
||
| [Feed Management](FEEDS.md) | RSS/REST feeds and posting to channels |
|
||
| [Web Viewer](WEB_VIEWER.md) | Web-based data viewer and API |
|
||
| [Documentation site setup](DOCS_SITE.md) | How to build and deploy this site |
|
||
|
||
## Service Plugins
|
||
|
||
| Document | Description |
|
||
|----------|-------------|
|
||
| [Service Plugins overview](service-plugins.md) | Enable and configure background services |
|
||
| [Discord Bridge](DISCORD_BRIDGE.md) | One-way bridge to Discord |
|
||
| [Packet Capture](PACKET_CAPTURE.md) | Packet capture and MQTT |
|
||
| [Map Uploader](MAP_UPLOADER.md) | Uploading to map.meshcore.dev |
|
||
| [Weather Service](WEATHER_SERVICE.md) | Scheduled weather and alerts |
|