/ opengrammar / ROADMAP.md
swadhinbiswas docs: add comprehensive feature implementation guide and update roadmap Β· 2/27/2026
cc54aba
160 lines Β· 6.6 KB
Raw Download

πŸ—ΊοΈ OpenGrammar Roadmap

Our vision is to build the most capable, privacy-respecting, and customizable writing assistant in the world. OpenGrammar is designed to be a completely open-source alternative to premium grammar tools.

This roadmap outlines the major phases of development, from the initial MVP to advanced features and broader platform support. It is a living document and will evolve based on community feedback and technological advancements.


βœ… Phase 1: Foundation & MVP (Completed)

The goal of this phase was to establish a solid, functional, and secure base architecture.

  • Chrome Extension Skeleton: Manifest V3 setup with React and Vite.
  • Serverless Backend: A stateless Hono API deployable to edge networks (Cloudflare/Vercel).
  • Dual Engine:
    • Local rule-based checks (40+ rules: passive voice, repetition, spacing, apostrophes, clichΓ©s, etc.)
    • AI-powered checks (OpenAI/OpenRouter/Groq/Together/Ollama compatible)
  • Privacy: Secure local storage for API keys (chrome.storage.sync); no backend logging or databases.
  • Core UI: Basic popup for configuration (toggling, setting API key/model).
  • Content Script MVP: Text extraction and basic visual highlighting for input, textarea, and standard contenteditable elements.
  • Interactive Tooltips: Click-to-apply suggestions with ignore and dictionary features.
  • Comprehensive Options Page: Site-specific settings, dictionary management, data export/import.
  • Docker Self-Hosting: Complete Docker setup with Ollama support for local LLM.
  • Multi-Provider Support: 6 AI providers (OpenAI, Groq, OpenRouter, Together, Ollama, Custom).

βœ… Phase 2: Enhanced User Experience (Completed)

This phase focused on making the extension feature-rich and highly customizable.

  • Tone & Style Rewriting:
    • 8 tone options (formal, casual, professional, friendly, concise, detailed, persuasive, neutral)
    • Context menu integration (right-click β†’ Rewrite)
    • Keyboard shortcut (Ctrl+Shift+R / Cmd+Shift+R)
    • Side-by-side text comparison UI
  • Writing Statistics Dashboard:
    • Word count, character count, sentence count, paragraph count
    • Flesch Reading Ease Score
    • Flesch-Kincaid Grade Level
    • Automated Readability Index (ARI)
    • Vocabulary diversity percentage
    • Reading/speaking time estimates
    • Issue breakdown by type
  • Custom Prompts for AI:
    • 8 preset prompts (Fix Grammar, Make Formal, Simplify, Summarize, etc.)
    • Prompt categories (grammar, style, creative, professional)
    • Extensible system for user-defined prompts
  • Better Google Docs Support: (See implementation guide)
  • Advanced Highlighting Engine:
    • Improve robustness inside complex contenteditable editors
    • Implement reliable inline underlines that move correctly

πŸš€ Phase 3: Advanced Capabilities (Planned)

Here we will leverage the AI engine to provide deeper insights and more powerful writing assistance.

  • Autocomplete & Prediction:
    • Suggest next few words as user types
    • Context-aware completions
    • Configurable suggestion length
  • Contextual Understanding:
    • Consider previous paragraphs for consistency
    • Document-wide tone analysis
    • Track terminology and style preferences
  • Reading Time Estimates: (Completed in Phase 2)
  • Vocabulary Diversity Metrics: (Completed in Phase 2)
  • Writing Analytics:
    • Track writing habits over time
    • Most used words analysis
    • Sentence length distribution
    • Weekly/monthly reports
  • Smart Suggestions:
    • Synonym recommendations for overused words
    • Transition word suggestions
    • Genre-specific recommendations

🌐 Phase 4: Expansion & Ecosystem (Planned)

The final phase aims to bring OpenGrammar to every platform where people write.

  • Cross-Browser Support:
    • Firefox extension (WebExtensions API)
    • Safari extension (Safari Web Extension Converter)
    • Edge extension (Chromium-based)
  • Desktop Applications:
    • Electron-based app for Windows, macOS, Linux
    • System-wide text input integration
    • Native messaging for full system access
  • Developer API:
    • Public REST API with authentication
    • Rate limiting and usage tiers
    • SDK packages (npm, pip)
    • API documentation portal
  • Community Ecosystem:
    • Custom rule marketplace
    • Shared prompt library
    • Language packs for non-English support
    • Plugin system for extensibility

πŸ“Š Feature Status Summary

Feature Status Version
Grammar Checking βœ… Complete v1.0
Multi-Provider AI βœ… Complete v2.0
Local LLM (Ollama) βœ… Complete v2.0
Interactive Tooltips βœ… Complete v1.0
Options Page βœ… Complete v1.0
Tone Rewriting βœ… Complete v2.1
Writing Statistics βœ… Complete v2.1
Custom Prompts βœ… Complete v2.1
Google Docs Support 🚧 In Progress -
Autocomplete πŸ“‹ Planned v3.0
Firefox Support πŸ“‹ Planned v3.0
Desktop Apps πŸ“‹ Planned v4.0
Developer API πŸ“‹ Planned v4.0

🀝 How to Help

We need developers, designers, and testers to make this roadmap a reality!

Contribution Areas

  1. Core Features: Pick a feature from Phase 3 or 4 and implement it
  2. Bug Fixes: Check the GitHub issues tab
  3. Documentation: Improve guides, add tutorials
  4. Testing: Test on different browsers and websites
  5. Translations: Help localize OpenGrammar for other languages

Getting Started

  1. Fork the repository
  2. Check FEATURES_IMPLEMENTATION.md for implementation guides
  3. Create a feature branch
  4. Submit a pull request

If you're interested in contributing, please start a discussion on GitHub or join our Discord server!


πŸ“… Release Timeline

Version Target Features
v2.1 Current Tone rewriting, statistics, custom prompts
v3.0 Q2 2026 Autocomplete, Firefox support, Google Docs
v3.5 Q3 2026 Contextual understanding, writing analytics
v4.0 Q4 2026 Desktop apps, Developer API, Safari support

Timeline is approximate and may change based on community contributions.