# 📚 Documentation Directory

This folder contains comprehensive documentation for the Microsoft Rewards Script project.

## 📋 Documentation Structure

### 🚀 Getting Started
- **[index.md](index.md)** — Documentation hub and navigation
- **[getting-started.md](getting-started.md)** — Complete setup guide for beginners
- **[FAQ.md](FAQ.md)** — Frequently asked questions

### ⚙️ Configuration
- **[config.md](config.md)** — Complete configuration reference
- **[accounts.md](accounts.md)** — Account setup and 2FA/TOTP configuration
- **[schedule.md](schedule.md)** — Automated scheduling setup

### 🔧 Features
- **[humanization.md](humanization.md)** — Anti-detection and natural behavior
- **[jobstate.md](jobstate.md)** — Job state management
- **[buy-mode.md](buy-mode.md)** — Manual purchase monitoring

### 🔔 Integrations
- **[conclusionwebhook.md](conclusionwebhook.md)** — Discord webhook setup
- **[ntfy.md](ntfy.md)** — NTFY push notification setup
- **[proxy.md](proxy.md)** — Proxy configuration

### 🐳 Deployment
- **[docker.md](docker.md)** — Docker deployment guide
- **[update.md](update.md)** — Update and upgrade guide

### 🛠️ Maintenance
- **[diagnostics.md](diagnostics.md)** — Troubleshooting and debugging
- **[security.md](security.md)** — Security and privacy guidelines
- **[git-conflict-resolution.md](git-conflict-resolution.md)** — Resolving Git conflicts

## 🎯 Quick Navigation by Use Case

### "I just installed the script"
1. [Getting Started](getting-started.md)
2. [Accounts Setup](accounts.md)
3. [Basic Configuration](config.md#quick-start)

### "I want automated daily runs"
1. [Scheduling](schedule.md)
2. [Docker Deployment](docker.md) (optional)
3. [Humanization](humanization.md)

### "I need notifications"
- [Discord Webhooks](conclusionwebhook.md)
- [NTFY Push Alerts](ntfy.md)

### "Something's not working"
1. [FAQ](FAQ.md)
2. [Diagnostics](diagnostics.md)
3. [Security Guide](security.md) (if banned)

## 📝 Documentation Standards

All documentation in this project follows these principles:

- **Clear and concise** — No unnecessary jargon
- **Example-driven** — Code samples for every feature
- **Up-to-date** — Reflects current functionality
- **Well-structured** — Easy navigation with TOC
- **Beginner-friendly** — Assumes minimal technical knowledge

## 🤝 Contributing to Documentation

Documentation improvements are always welcome! See [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines.

### How to Help

- Fix typos or unclear instructions
- Add missing examples
- Improve explanations
- Translate to other languages
- Update outdated information

## 📖 Documentation Format

All docs use **Markdown** format with:
- Clear hierarchical headings
- Code blocks with syntax highlighting
- Tables for configuration options
- Emojis for visual navigation
- Internal links for cross-references

## 🔗 External Resources

- **[Main README](../README.md)** — Project overview
- **[Contributing Guide](../CONTRIBUTING.md)** — How to contribute
- **[Security Policy](../SECURITY.md)** — Security and privacy
- **[Changelog](../CHANGELOG.md)** — Version history

---

<div align="center">

**[Start Reading →](index.md)**

Need help? [Join our Discord](https://discord.gg/h6Z69ZPPCz)

</div>