docs(readme): marketing-forward rewrite#84
Conversation
…gin/
README:
- Lead with problem framing ("Your AI keeps making the same mistakes")
- 30-second pitch table moved up with vs Mem0 / vs fine-tuning / vs system prompts
- Kept ablation v4 data + Min 2022 random-label control
- Merged new JS/TS (@gradata/cli) and Docker install paths from #80
- Preserved Inspection & Transparency API section from #56
- Tightened features into scannable single-line blocks
- Repo layout + intellectual lineage kept but demoted below primary CTA
.gitignore:
- Add gradata-plugin/ (orphaned clone of separate plugin repo, superseded by
.claude-plugin/ in this repo via #53; can't be rm'd due to OneDrive lock)
Co-Authored-By: Gradata <noreply@gradata.ai>
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Gradata has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.
📝 Walkthrough
WalkthroughProject documentation and configuration updated to reflect reframed messaging around mistake prevention, simplified architecture, and restructured setup guidance. Gitignore configuration extended to exclude the gradata-plugin directory. Licensing statement simplified from dual-license to single AGPL-3.0 with commercial alternative. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 3: The README heading "Your AI keeps making the same mistakes. Gradata
makes it stop." is using an H3 (###) and should be H2 to avoid a heading-level
jump from H1 to H3; update that line to use `##` instead of `###` so the
document preserves proper heading hierarchy and satisfies markdown lint rules.
- Around line 127-130: Add a language tag to the fenced code block containing
the two plugin commands so markdown lint passes and readability improves: locate
the fenced block that includes the lines "/plugin marketplace add
Gradata/gradata" and "/plugin install gradata" and change the opening backticks
to include the language (e.g., ```bash) so the block begins with ```bash instead
of just ```.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 3aed812f-b649-4afa-9b00-2fa61406914b
📒 Files selected for processing (2)
.gitignoreREADME.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~10-~10: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...) You fix a tone. You rewrite a regex. You re-explain how your team formats PRs. T...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.22.0)
README.md
[warning] 3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
[warning] 127-127: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
.gitignore (1)
17-17: Good ignore-rule addition for local plugin artifacts.Line 17 cleanly prevents accidental commits from the local
gradata-plugin/clone and is consistent with the rest of this ignore strategy.README.md (1)
10-310: Strong documentation restructure overall.The revised flow (pitch → mechanism → evidence → install paths → transparency) is clearer and better aligned to onboarding and evaluation.
| # Gradata | ||
|
|
||
| ## AI that learns your judgment, not just your preferences. | ||
| ### Your AI keeps making the same mistakes. Gradata makes it stop. |
There was a problem hiding this comment.
Fix heading hierarchy jump (H1 → H3).
Line 3 skips ##, which triggers markdown heading-structure lint warnings and can hurt navigation semantics.
Suggested diff
-### Your AI keeps making the same mistakes. Gradata makes it stop.
+## Your AI keeps making the same mistakes. Gradata makes it stop.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Your AI keeps making the same mistakes. Gradata makes it stop. | |
| ## Your AI keeps making the same mistakes. Gradata makes it stop. |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 3-3: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 3, The README heading "Your AI keeps making the same
mistakes. Gradata makes it stop." is using an H3 (###) and should be H2 to avoid
a heading-level jump from H1 to H3; update that line to use `##` instead of
`###` so the document preserves proper heading hierarchy and satisfies markdown
lint rules.
| ``` | ||
| /plugin marketplace add Gradata/gradata | ||
| /plugin install gradata | ||
| ``` |
There was a problem hiding this comment.
Add a language tag to this fenced code block.
Line 127 should specify the code language to satisfy markdown lint rules and improve readability.
Suggested diff
-```
+```bash
/plugin marketplace add Gradata/gradata
/plugin install gradata</details>
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.22.0)</summary>
[warning] 127-127: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @README.md around lines 127 - 130, Add a language tag to the fenced code
block containing the two plugin commands so markdown lint passes and readability
improves: locate the fenced block that includes the lines "/plugin marketplace
add Gradata/gradata" and "/plugin install gradata" and change the opening
backticks to include the language (e.g., bash) so the block begins with bash instead of just ```.
</details>
<!-- fingerprinting:phantom:triton:hawk:0ba4b825-d7c8-4967-9efa-3ed1bb3e5f2a -->
<!-- This is an auto-generated comment by CodeRabbit -->
1 participant
Summary
Rewrite of the public README in marketing-forward style, merged cleanly against the new JS/TS + Docker distribution paths (#80) and the Inspection & Transparency API surface (#56) that landed overnight.
Also: added `gradata-plugin/` to .gitignore. A stale clone of the old separate plugin repo is on disk from before #53 collapsed it into this repo; it's locked by OneDrive and can't be rm'd programmatically. Ignoring prevents churn in `git status`.
Test plan
Co-Authored-By: Gradata noreply@gradata.ai