mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-08-15 15:09:48 +00:00
agessaman
d78b29b6b5
Consistency pass ahead of the 1.0.0 release. `mkdocs build --strict` now completes with no warnings; it previously failed. - mkdocs.yml: the nav referenced `feeds.md` but the file is `FEEDS.md`. This resolved on case-insensitive macOS and broke on the Linux CI runner, so the live site shipped a dead Feed Management link. - mkdocs.yml: add eight pages that existed and were linked from docs/index.md but were absent from the nav, so they were unreachable by site navigation: World Cup, Earthquake, Telegram Bridge, Repeater Prefix Collision, Repeater Commands, and the custom command website. Exclude docs/integration/, which is an internal development log. - faq.md: the recovery snippets pointed at /opt/meshcore-bot/meshcore_bot.db. Since the service-layout hardening the database lives in /var/lib/meshcore-bot, and /opt is root-owned, so `sudo -u meshcore` could not write there. sqlite3.connect() would have created an empty database and failed with a confusing "no such table" instead of a clear permissions error. - repeater-commands.md: section headings containing "&" generated different anchors under GitHub and MkDocs, so the table of contents worked in one renderer and broke in the other. Use "and" so both produce the same slug. Point the Auto-Purge entry at the subsection that exists; it previously matched no heading in either renderer. - command-reference.md: document the `webviewer` command, the only one of 44 command modules with no entry. - checkin-api.md: link the reference receiver on GitHub rather than by a relative path that escapes the docs tree. - index.md: add the upgrade guide, FAQ, data retention, local plugins, check-in API, and custom command website.
2.4 KiB
2.4 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
- Upgrade guide – What changes between releases, and how to upgrade
- FAQ – Common problems and fixes
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 |
| Data retention | How long the bot keeps captured data |
| Local plugins and services | Add your own commands and services |
| Check-in API | Submit check-ins to an external web API |
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 |
| Custom command website | Generate an HTML command reference for your users |
Service Plugins
| Document | Description |
|---|---|
| Service Plugins overview | Enable and configure background services |
| Discord Bridge | One-way bridge to Discord |
| Telegram Bridge | One-way bridge to Telegram |
| Earthquake Service | Scheduled earthquake alerts from USGS |
| Packet Capture | Packet capture and MQTT |
| Map Uploader | Uploading to map.meshcore.dev |
| Weather Service | Scheduled weather and alerts |
| Repeater Prefix Collision Service | Detect repeater prefix collisions |
| World Cup | World Cup command and live match announcements |