swadhin / opengrammar public

docs: update official docs for rule configuration toggles

Swadhin Biswas committed 7 months ago
fc51dda
1 parent 91cb77b
commit fc51dda
2 files changed
+24 -7
Showing 2 changed files+24-7
docs/09-using-opengrammar.mddocs/15-api-reference.md
▼docs/09-using-opengrammar.md
+21-0
@@ -464,6 +464,27 @@ My Custom Dictionary (127 words)
464
464
465
465
---
466
466
467
+## ⚙️ Rule Configuration (Preferences)
468
+
469
+### Overview
470
+
471
+Sometimes you want OpenGrammar to focus only on typos, or maybe you want to disable strict Style & Tone rules entirely. OpenGrammar lets you disable specific rule categories globally.
472
+
473
+### Managing Rule Categories
474
+
475
+1. Right-click the extension icon → **Options**
476
+2. Scroll to **Writing Preferences**
477
+3. Toggle the categories you want active:
478
+ - **Grammar:** Subject-verb agreement, irregular verbs, pronouns
479
+ - **Spelling:** Typos, misspelled words, confused words
480
+ - **Punctuation:** Missing commas, incorrect hyphens
481
+ - **Style & Tone:** Formality, academic writing, business etiquette
482
+ - **Clarity:** Wordiness, redundant phrasing, readability
483
+
484
+If you disable "Style & Tone," OpenGrammar will instantly stop checking for passive voice or casual phrasing (like "gonna" or "btw") everywhere on the internet.
485
+
486
+---
487
+
467
488
## 🌐 Site-Specific Settings
468
489
469
490
### Overview
470
491
▼docs/15-api-reference.md
+3-7
@@ -155,12 +155,7 @@ curl -X POST http://localhost:8787/analyze \
155
155
"provider": "groq",
156
156
"model": "llama-3.1-70b-versatile",
157
157
"apiKey": "gsk_xxx",
158
- "options": {
159
- "checkGrammar": true,
160
- "checkSpelling": true,
161
- "checkStyle": true,
162
- "checkClarity": true
163
- }
158
+ "disabledModules": ["style", "clarity"]
164
159
}'
165
160
```
166
161
@@ -171,7 +166,8 @@ curl -X POST http://localhost:8787/analyze \
171
166
| `provider` | string | No | AI provider (default: rule-based only) |
172
167
| `model` | string | No | Model to use |
173
168
| `apiKey` | string | No | API key (if not set in env) |
174
-| `options` | object | No | Analysis options |
169
+| `disabledModules` | array | No | List of rule categories to completely disable (e.g. `["grammar", "spelling", "punctuation", "style", "clarity"]`) |
170
+| `dictionary` | array | No | List of words to ignore during spellchecking |
175
171
176
172
**Response (200 OK):**
177
173
```json
178
174