feat: update documentation and improve error reporting features

This commit is contained in:
2025-12-16 20:59:58 +01:00
parent 1a19c880f7
commit a5ecf36668
7 changed files with 253 additions and 214 deletions

View File

@@ -1,16 +1,37 @@
# Microsoft Rewards Bot Docs
This folder contains short, task-focused guides. Pick what you need and keep runs simple.
Welcome to the **v3.5 Remaster** documentation. These guides cover everything from first-time setup to advanced configuration.
- **[Setup](setup.md)** — prerequisites and preparing account files.
- **[Running](running.md)** — commands to start the bot.
- **[Modes](modes.md)** — what each mode does and when to use it.
- **[Configuration](configuration.md)** — adjust the core settings file.
- **[Account Creation](account-creation.md)** — create new accounts safely.
- **[Dashboard](dashboard.md)** — view progress in the web panel.
- **[Scheduling](scheduling.md)** — automate runs on a schedule.
- **[Notifications](notifications.md)** — send alerts to Discord or other webhooks.
- **[Error Reporting](error-reporting.md)** — send structured error reports to Discord.
- **[Docker](docker.md)** — run the bot in a container.
- **[Update](update.md)** — keep the project up to date.
- **[Troubleshooting](troubleshooting.md)** — quick fixes for common issues.
## Getting Started
- **[Setup](setup.md)** — Install prerequisites and configure your accounts.
- **[Running](running.md)** — Commands to start the bot.
- **[Modes](modes.md)** — Understand the different running modes.
## Configuration
- **[Configuration](configuration.md)** — Adjust bot behavior via `config.jsonc`.
- **[Scheduling](scheduling.md)** — Automate daily runs with built-in scheduler.
- **[Notifications](notifications.md)** — Discord webhooks and NTFY push alerts.
## Features
- **[Dashboard](dashboard.md)** — Real-time web monitoring panel.
- **[Account Creation](account-creation.md)** — Create new Microsoft accounts (use with caution).
- **[Error Reporting](error-reporting.md)** — Automatic anonymized bug reports.
## Deployment
- **[Docker](docker.md)** — Run the bot in a container with scheduling.
- **[Update](update.md)** — Keep the project up to date.
## Help
- **[Troubleshooting](troubleshooting.md)** — Quick fixes for common issues.
---
## Quick Reference
| Command | Description |
|---------|-------------|
| `npm start` | Build and run the bot |
| `npm run dashboard` | Start web monitoring panel |
| `npm run creator` | Account creation wizard |
| `npm run dev` | Development mode |
| `npm run docker:compose` | Run in Docker |