mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-03-30 12:05:38 +00:00
16322e0631
- Added an overview link to the installation section in mkdocs.yml for better accessibility. - Renamed the Command Reference documentation file from `commands.md` to `command-reference.md` for consistency. - Updated all references to the Command Reference in README.md, getting-started.md, and index.md to reflect the new file name.
1.6 KiB
1.6 KiB
meshcore-bot Documentation
Documentation for the MeshCore bot: setup, configuration, commands, and services.
New to the project? Start with Getting Started.
Project overview
- README – Getting started, installation, quick start
- Command Reference – Full command reference
- Docker deployment – Docker deployment
- Service installation – Systemd service setup
- Web Viewer – Web viewer module
Configuration
| Document | Description |
|---|---|
| Configuration | config.ini structure and command options |
| Path Command | Path command presets and tuning |
| Config validation | Validate config.ini before starting the bot |
Guides
| Document | Description |
|---|---|
| Repeater Commands | Repeater management DM commands |
| Feed Management | RSS/REST feeds and posting to channels |
| Web Viewer | Web-based data viewer and API |
Service Plugins
| Document | Description |
|---|---|
| Service Plugins overview | Enable and configure background services |
| Discord Bridge | One-way bridge to Discord |
| Packet Capture | Packet capture and MQTT |
| Map Uploader | Uploading to map.meshcore.dev |
| Weather Service | Scheduled weather and alerts |