swadhin / opengrammar public

docs: add project roadmap

swadhinbiswas committed 8 months ago
40f2eb6
1 parent 356d58b
commit 40f2eb6
1 file changed
+67 -0
Showing 1 changed file+67-0
ROADMAP.md
▼ROADMAP.md
+67-0
@@ -0,0 +1,67 @@
1
+# 🗺️ OpenGrammar Roadmap
2
+
3
+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.
4
+
5
+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.
6
+
7
+---
8
+
9
+## 🎯 Phase 1: Foundation & MVP (Current)
10
+
11
+The goal of this phase is to establish a solid, functional, and secure base architecture that proves the concept of a privacy-first, dual-engine writing assistant.
12
+
13
+* [x] **Chrome Extension Skeleton:** Manifest V3 setup with React and Vite.
14
+* [x] **Serverless Backend:** A stateless Hono API deployable to edge networks (Cloudflare/Vercel).
15
+* [x] **Dual Engine:**
16
+ * [x] Local rule-based checks (passive voice, repetition).
17
+ * [x] AI-powered checks (OpenAI compatibility) with a strict JSON response format.
18
+* [x] **Privacy:** Secure local storage for API keys (`chrome.storage.sync`); no backend logging or databases.
19
+* [x] **Core UI:** Basic popup for configuration (toggling, setting API key/model).
20
+* [x] **Content Script MVP:** Text extraction and basic visual highlighting for `input`, `textarea`, and standard `contenteditable` elements.
21
+
22
+---
23
+
24
+## 🚀 Phase 2: Enhanced User Experience & Accuracy (Next Steps)
25
+
26
+This phase focuses on making the extension feel natural, responsive, and highly accurate across a wider variety of modern web applications.
27
+
28
+* **Advanced Highlighting Engine:**
29
+ * Improve the robustness of highlighting inside complex `contenteditable` editors (like Google Docs, Notion, and rich text webmail).
30
+ * Implement reliable inline underlines that move correctly when text is edited or scrolled.
31
+* **Interactive Tooltips:**
32
+ * Develop a polished, floating UI when hovering over an issue.
33
+ * Enable "Click to Apply" functionality to instantly replace the original text with the suggested correction.
34
+ * Allow users to "Ignore" a suggestion or "Add to Dictionary" for false positives.
35
+* **Smarter Local Rules:**
36
+ * Expand the local, non-AI rule engine using lightweight natural language processing (NLP) libraries (like `compromise` or a small WASM-based parser) to catch more errors offline and for free.
37
+* **Custom Prompts:** Allow advanced users to customize the system prompt sent to the AI (e.g., "Make my writing sound more professional" or "Translate to UK English").
38
+
39
+---
40
+
41
+## 🧠 Phase 3: Advanced Capabilities & Context
42
+
43
+Here, we will leverage the AI engine to provide deeper insights and more powerful writing assistance beyond basic grammar and spelling.
44
+
45
+* **Tone & Style Adjustments:** Options to rewrite a selected paragraph for a specific tone (e.g., Confident, Friendly, Formal, Concise).
46
+* **Autocomplete & Prediction:** Suggest the next few words or sentences as the user types, similar to advanced editor features.
47
+* **Contextual Understanding:** Allow the AI to consider the surrounding text (or even the page context, if permitted by the user) to provide more accurate suggestions, rather than just analyzing isolated sentences.
48
+* **Writing Statistics:** Provide users with insights into their writing habits (e.g., vocabulary diversity, average readability score) processed entirely locally.
49
+
50
+---
51
+
52
+## 🌐 Phase 4: Expansion & Ecosystem
53
+
54
+The final phase aims to bring OpenGrammar to every platform where people write.
55
+
56
+* **Cross-Browser Support:**
57
+ * Port the extension to Firefox (using WebExtensions API).
58
+ * Port the extension to Safari.
59
+* **Desktop Applications:** Create standalone desktop apps for Windows, macOS, and Linux that integrate with system-wide text inputs.
60
+* **Developer API:** Offer a documented, self-hostable API so other developers can integrate the OpenGrammar engine into their own applications.
61
+* **Community Rule Marketplace:** A repository where the community can share and install custom rule sets or AI prompts for specific domains (e.g., legal writing, medical writing, creative fiction).
62
+
63
+---
64
+
65
+## 🤝 How to Help
66
+
67
+We need developers, designers, and testers to make this roadmap a reality. If you're interested in contributing, please pick an issue from our GitHub repository or start a discussion!
0
68