docs: rewrite README for a non-technical audience#638
Conversation
The README read like an engineering doc, but the primary audience is the 6000+ people deciding whether to install. This pass keeps the layout, badges, and CTAs and makes the prose user-first. - De-jargon the Engines section: lead with the plain Apple Intelligence vs. Open Source choice plus a "Good for" model table; move GGUF/llama.cpp internals, model filenames, quants, and bring-your-own into a collapsed <details>. Engine labels still match the in-app Settings wording. - Fix the keyboard model: Tab accepts the next word (not the whole suggestion); document backtick (accept all) and Esc; add a "Using Cotabby" section. - Add a short Privacy section (on-device, no telemetry, no disk writes). - De-jargon Features (drop "llama.cpp", "OCR", "on-screen awareness"). - Note Screen Recording is optional; never reads secure fields. - Fix dashes per house style (spaced hyphen / "--" -> em-dash). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
| ## Engines | ||
|
|
||
| **Apple Intelligence**: uses Apple's on-device `FoundationModels` runtime on macOS 26 or later, no download required. | ||
| Cotabby generates suggestions one of two ways. You choose which in Settings → Engine: |
There was a problem hiding this comment.
The Settings sidebar label for the engine pane is "Engine & Model" (see
SettingsCategory.engineAndModel → "Engine & Model" in SettingsCategory.swift), not just "Engine". A user following this navigation path will scan the sidebar for a pane called "Engine" and may not find it immediately.
| Cotabby generates suggestions one of two ways. You choose which in Settings → Engine: | |
| Cotabby generates suggestions one of two ways. You choose which in Settings → Engine & Model: |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
|
|
||
| Start typing in almost any text field. When a gray suggestion appears: | ||
|
|
||
| - **`Tab`** — accept the next word. (Prefer whole phrases? Switch this in Settings → Acceptance Mode.) |
There was a problem hiding this comment.
"Acceptance Mode" is not a top-level Settings pane — it's a picker control inside the "Shortcuts" pane (
AcceptanceModePickerView is rendered by ShortcutsPaneView). Users following "Settings → Acceptance Mode" will look for a sidebar entry that doesn't exist. The correct navigation is "Settings → Shortcuts".
| - **`Tab`** — accept the next word. (Prefer whole phrases? Switch this in Settings → Acceptance Mode.) | |
| - **`Tab`** — accept the next word. (Prefer whole phrases? Switch this in Settings → Shortcuts.) |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
What & why
Feedback we got: the README reads as too technical. The primary audience on this page is the 6000+ people deciding whether to install — not contributors. This pass keeps the layout, badges, and CTAs (download + support stay up top) and rewrites the prose to be user-first.
Changes
<details>for power users. Engine labels still match the in-app Settings wording.Tabaccepts the whole suggestion. It accepts the next word; backtick accepts the whole thing;Escdismisses. Added a short Using Cotabby section spelling this out.--→ em-dashes.Open question
ko-fi.com/I2F22066MI; the landing site usesko-fi.com/cotabby. Left as-is to avoid touching a payment link — worth unifying if they're the same account.🤖 Generated with Claude Code
Greptile Summary
This PR rewrites
README.mdto prioritize the non-technical installer audience: it de-jargons the Engines section, adds Privacy and Using Cotabby sections, collapses GGUF/llama.cpp internals behind a<details>block, and corrects the keyboard model (Tab → next word, backtick → whole suggestion).acceptCurrentSuggestion()implementation.Settings → Engine(actual label: Engine & Model) andSettings → Acceptance Mode(a picker inside Shortcuts, not its own pane).Confidence Score: 3/5
The README rewrite is largely accurate and well-structured, but two navigation instructions direct users to Settings panel names that don't match the app UI.
The prose and keyboard model corrections are solid. However, two user-facing navigation paths ("Settings → Engine" and "Settings → Acceptance Mode") reference labels that don't exist in the Settings sidebar — the actual panels are "Engine & Model" and "Shortcuts" respectively. Users who follow these instructions verbatim will be confused when they don't find the named panel.
README.md — specifically the "Engines" and "Using Cotabby" sections where Settings navigation paths are specified.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[User opens Settings] --> B{Engine choice} B -->|macOS 26+ / Apple Silicon| C[Apple Intelligence] B -->|macOS 14+, any Mac| D[Open Source Engine] D --> E{Pick a model} E --> F[tabby-2-nano ~0.8 GB] E --> G[tabby-2-mini ~1.4 GB] E --> H[tabby-2-base ~4.5 GB] E --> I[tabby-2-pro ~5.0 GB] E --> J[Bring Your Own GGUF] subgraph Suggestion Flow K[User types] --> L{Suggestion appears?} L -->|Yes| M[Tab: accept next word] L -->|Yes| N[Backtick: accept whole suggestion] L -->|Yes| O[Esc / keep typing: dismiss] L -->|No| K endReviews (1): Last reviewed commit: "docs: rewrite README for a non-technical..." | Re-trigger Greptile