📚 OpenGrammar Documentation
Welcome to the complete documentation for OpenGrammar - your privacy-first, open-source writing assistant.
📖 Table of Contents
Getting Started
- Quick Start - Get up and running in 5 minutes
- What is OpenGrammar? - Overview and features
- System Requirements - What you need to run OpenGrammar
Installation & Setup
- Browser Extension Setup - Chrome, Brave, Edge, Firefox
- Backend Deployment - Complete deployment guide
Configuration
- AI Provider Setup - Configure AI providers
- Extension Settings - Configure the extension
- Custom Dictionary - Manage your dictionary
User Guide
- Using OpenGrammar - Daily usage guide
- Grammar Checking - How to check grammar
- Tone Rewriting - Rewrite text in different tones
- Writing Statistics - Analyze your writing
- Keyboard Shortcuts - All shortcuts reference
Developer Guide
- Architecture Overview - System architecture
- Local Development - Development setup
- API Reference - Backend API documentation
- Adding Grammar Rules - Contribute grammar rules
- Building the Extension - Build and package
Troubleshooting
- Troubleshooting Guide - Common issues and solutions
- FAQ - Frequently asked questions
- Error Codes - Error code reference
Contributing
- Contributing Guide - How to contribute
- Code Style - Coding standards
- Roadmap - Future development
🚀 Quick Links
| I want to... | Go to... |
|---|---|
| Install the extension | Browser Extension Setup |
| Deploy the backend | Backend Deployment |
| Configure AI providers | AI Provider Setup |
| Use tone rewriting | Tone Rewriting |
| Report a bug | GitHub Issues |
| Suggest a feature | GitHub Discussions |
📞 Support
- GitHub Issues: Report bugs or request features
- GitHub Discussions: Ask questions and discuss ideas
- Documentation: Complete guides and tutorials
📄 License
OpenGrammar is licensed under the Apache 2.0 License - see the LICENSE file for details.
Last Updated: March 2026
Version: 2.1.0