# 📚 OpenGrammar Documentation

Welcome to the complete documentation for OpenGrammar - your privacy-first, open-source writing assistant.

---

## 📖 Table of Contents

### Getting Started
- [**Quick Start**](docs/01-quick-start.md) - Get up and running in 5 minutes
- [**What is OpenGrammar?**](docs/02-what-is-opengrammar.md) - Overview and features
- [**System Requirements**](docs/03-system-requirements.md) - What you need to run OpenGrammar

### Installation & Setup
- [**Browser Extension Setup**](docs/04-browser-extension-setup.md) - Chrome, Brave, Edge, Firefox
- [**Backend Deployment**](docs/05-backend-deployment.md) - Complete deployment guide
  - [Cloudflare Workers](docs/05-backend-deployment.md#cloudflare-workers)
  - [Vercel](docs/05-backend-deployment.md#vercel)
  - [Railway](docs/05-backend-deployment.md#railway)
  - [Render](docs/05-backend-deployment.md#render)
  - [Docker Self-Hosting](docs/06-docker-self-hosting.md)

### Configuration
- [**AI Provider Setup**](docs/07-ai-providers.md) - Configure AI providers
  - [Groq (Free Tier)](docs/07-ai-providers.md#groq)
  - [OpenAI](docs/07-ai-providers.md#openai)
  - [OpenRouter](docs/07-ai-providers.md#openrouter)
  - [Together AI](docs/07-ai-providers.md#together-ai)
  - [Ollama (Local)](docs/07-ai-providers.md#ollama-local)
- [**Extension Settings**](docs/08-extension-settings.md) - Configure the extension
- [**Custom Dictionary**](docs/08-extension-settings.md#custom-dictionary) - Manage your dictionary

### User Guide
- [**Using OpenGrammar**](docs/09-using-opengrammar.md) - Daily usage guide
- [**Grammar Checking**](docs/09-using-opengrammar.md#grammar-checking) - How to check grammar
- [**Tone Rewriting**](docs/10-tone-rewriting.md) - Rewrite text in different tones
- [**Writing Statistics**](docs/11-writing-statistics.md) - Analyze your writing
- [**Keyboard Shortcuts**](docs/12-keyboard-shortcuts.md) - All shortcuts reference

### Developer Guide
- [**Architecture Overview**](docs/13-architecture.md) - System architecture
- [**Local Development**](docs/14-local-development.md) - Development setup
- [**API Reference**](docs/15-api-reference.md) - Backend API documentation
- [**Adding Grammar Rules**](docs/16-grammar-rules.md) - Contribute grammar rules
- [**Building the Extension**](docs/17-building-extension.md) - Build and package

### Troubleshooting
- [**Troubleshooting Guide**](docs/18-troubleshooting.md) - Common issues and solutions
- [**FAQ**](docs/19-faq.md) - Frequently asked questions
- [**Error Codes**](docs/20-error-codes.md) - Error code reference

### Contributing
- [**Contributing Guide**](docs/21-contributing.md) - How to contribute
- [**Code Style**](docs/22-code-style.md) - Coding standards
- [**Roadmap**](../ROADMAP.md) - Future development

---

## 🚀 Quick Links

| I want to... | Go to... |
|--------------|----------|
| Install the extension | [Browser Extension Setup](docs/04-browser-extension-setup.md) |
| Deploy the backend | [Backend Deployment](docs/05-backend-deployment.md) |
| Configure AI providers | [AI Provider Setup](docs/07-ai-providers.md) |
| Use tone rewriting | [Tone Rewriting](docs/10-tone-rewriting.md) |
| Report a bug | [GitHub Issues](https://github.com/swadhinbiswas/opengrammar/issues) |
| Suggest a feature | [GitHub Discussions](https://github.com/swadhinbiswas/opengrammar/discussions) |

---

## 📞 Support

- **GitHub Issues**: [Report bugs or request features](https://github.com/swadhinbiswas/opengrammar/issues)
- **GitHub Discussions**: [Ask questions and discuss ideas](https://github.com/swadhinbiswas/opengrammar/discussions)
- **Documentation**: [Complete guides and tutorials](https://github.com/swadhinbiswas/opengrammar/tree/main/opengrammar)

---

## 📄 License

OpenGrammar is licensed under the Apache 2.0 License - see the [LICENSE](../LICENSE) file for details.

---

**Last Updated:** March 2026  
**Version:** 2.1.0