diff --git a/README.md b/README.md index d572a4f..6ba6039 100644 --- a/README.md +++ b/README.md @@ -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. ## 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. diff --git a/docs/account-creation.md b/docs/account-creation.md index f8d2fcb..3ff05b2 100644 --- a/docs/account-creation.md +++ b/docs/account-creation.md @@ -12,3 +12,6 @@ Creates new Microsoft accounts and prepares them for Rewards. ```bash npm run creator -- -y backup@example.com ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/configuration.md b/docs/configuration.md index 60971e1..6c49e2f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -21,3 +21,6 @@ Controls how the bot behaves through `src/config.jsonc`. "scheduling": { "enabled": false } } ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/dashboard.md b/docs/dashboard.md index d0cc6b0..d20143d 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -12,3 +12,6 @@ Shows live status and logs in a simple web page. ```bash npm run dashboard ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/docker.md b/docs/docker.md index bb92b32..84b270b 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -12,3 +12,6 @@ Runs the bot in a container with bundled scheduling and browser setup. ```bash npm run docker:compose ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/error-reporting.md b/docs/error-reporting.md index 93748fa..693ec5c 100644 --- a/docs/error-reporting.md +++ b/docs/error-reporting.md @@ -14,3 +14,6 @@ curl -X POST https://your-deployment.vercel.app/api/report-error \ -H "Content-Type: application/json" \ -d '{"error":"Search job failed","type":"search","metadata":{"account":"user@contoso.com"}}' ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/index.md b/docs/index.md index 0910743..62798d5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,15 +2,15 @@ This folder contains short, task-focused guides. Pick what you need and keep runs simple. -- `setup.md` — prerequisites and preparing account files. -- `running.md` — commands to start the bot. -- `modes.md` — what each mode does and when to use it. -- `configuration.md` — adjust the core settings file. -- `account-creation.md` — create new accounts safely. -- `dashboard.md` — view progress in the web panel. -- `scheduling.md` — automate runs on a schedule. -- `notifications.md` — send alerts to Discord or other webhooks. -- `error-reporting.md` — send structured error reports to Discord. -- `docker.md` — run the bot in a container. -- `update.md` — keep the project up to date. -- `troubleshooting.md` — quick fixes for common issues. +- **[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. diff --git a/docs/modes.md b/docs/modes.md index 417df0b..e0aa735 100644 --- a/docs/modes.md +++ b/docs/modes.md @@ -14,3 +14,6 @@ Lists the main modes and when to pick them. ```bash npm run dashboard ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/notifications.md b/docs/notifications.md index 0726842..ae628ba 100644 --- a/docs/notifications.md +++ b/docs/notifications.md @@ -13,3 +13,6 @@ Sends run summaries and issues to your preferred webhook. set DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/... npm start ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/running.md b/docs/running.md index 97f780b..8c01a59 100644 --- a/docs/running.md +++ b/docs/running.md @@ -14,3 +14,6 @@ Explains the basic commands to start the bot. ```bash npm start ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/scheduling.md b/docs/scheduling.md index 52b6acb..c43155e 100644 --- a/docs/scheduling.md +++ b/docs/scheduling.md @@ -17,3 +17,6 @@ Runs the bot automatically at set times. } } ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/setup.md b/docs/setup.md index 72d52d5..79a984c 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -20,3 +20,6 @@ Creates a safe baseline so your accounts and config are ready. } ] ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 7824314..8ec338d 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -16,3 +16,6 @@ npm install npm run build npm start ``` + +--- +**[← Back to Documentation](index.md)** diff --git a/docs/update.md b/docs/update.md index 02c4ce8..741eabe 100644 --- a/docs/update.md +++ b/docs/update.md @@ -12,3 +12,6 @@ Keeps the bot current with the official release. ```bash npm run update ``` + +--- +**[← Back to Documentation](index.md)**