docs: update documentation with navigation links to improve accessibility

This commit is contained in:
2025-12-06 13:21:03 +01:00
parent 64352fa306
commit b562af43ca
14 changed files with 49 additions and 13 deletions

View File

@@ -38,4 +38,4 @@ Automates Microsoft Rewards tasks so you collect points with minimal setup.
- Use account creation mode only if you accept this risk. - Use account creation mode only if you accept this risk.
## Documentation ## Documentation
Short guides live in `docs/index.md`. Explore the **[full documentation](docs/index.md)** for detailed guides on setup, running modes, scheduling, and troubleshooting.

View File

@@ -12,3 +12,6 @@ Creates new Microsoft accounts and prepares them for Rewards.
```bash ```bash
npm run creator -- -y backup@example.com npm run creator -- -y backup@example.com
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -21,3 +21,6 @@ Controls how the bot behaves through `src/config.jsonc`.
"scheduling": { "enabled": false } "scheduling": { "enabled": false }
} }
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -12,3 +12,6 @@ Shows live status and logs in a simple web page.
```bash ```bash
npm run dashboard npm run dashboard
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -12,3 +12,6 @@ Runs the bot in a container with bundled scheduling and browser setup.
```bash ```bash
npm run docker:compose npm run docker:compose
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -14,3 +14,6 @@ curl -X POST https://your-deployment.vercel.app/api/report-error \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{"error":"Search job failed","type":"search","metadata":{"account":"user@contoso.com"}}' -d '{"error":"Search job failed","type":"search","metadata":{"account":"user@contoso.com"}}'
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -2,15 +2,15 @@
This folder contains short, task-focused guides. Pick what you need and keep runs simple. This folder contains short, task-focused guides. Pick what you need and keep runs simple.
- `setup.md` — prerequisites and preparing account files. - **[Setup](setup.md)** — prerequisites and preparing account files.
- `running.md` — commands to start the bot. - **[Running](running.md)** — commands to start the bot.
- `modes.md` — what each mode does and when to use it. - **[Modes](modes.md)** — what each mode does and when to use it.
- `configuration.md` — adjust the core settings file. - **[Configuration](configuration.md)** — adjust the core settings file.
- `account-creation.md` — create new accounts safely. - **[Account Creation](account-creation.md)** — create new accounts safely.
- `dashboard.md` — view progress in the web panel. - **[Dashboard](dashboard.md)** — view progress in the web panel.
- `scheduling.md` — automate runs on a schedule. - **[Scheduling](scheduling.md)** — automate runs on a schedule.
- `notifications.md` — send alerts to Discord or other webhooks. - **[Notifications](notifications.md)** — send alerts to Discord or other webhooks.
- `error-reporting.md` — send structured error reports to Discord. - **[Error Reporting](error-reporting.md)** — send structured error reports to Discord.
- `docker.md` — run the bot in a container. - **[Docker](docker.md)** — run the bot in a container.
- `update.md` — keep the project up to date. - **[Update](update.md)** — keep the project up to date.
- `troubleshooting.md` — quick fixes for common issues. - **[Troubleshooting](troubleshooting.md)** — quick fixes for common issues.

View File

@@ -14,3 +14,6 @@ Lists the main modes and when to pick them.
```bash ```bash
npm run dashboard npm run dashboard
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -13,3 +13,6 @@ Sends run summaries and issues to your preferred webhook.
set DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/... set DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/...
npm start npm start
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -14,3 +14,6 @@ Explains the basic commands to start the bot.
```bash ```bash
npm start npm start
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -17,3 +17,6 @@ Runs the bot automatically at set times.
} }
} }
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -20,3 +20,6 @@ Creates a safe baseline so your accounts and config are ready.
} }
] ]
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -16,3 +16,6 @@ npm install
npm run build npm run build
npm start npm start
``` ```
---
**[← Back to Documentation](index.md)**

View File

@@ -12,3 +12,6 @@ Keeps the bot current with the official release.
```bash ```bash
npm run update npm run update
``` ```
---
**[← Back to Documentation](index.md)**