docs: Fix Readme Instructions #1706
Conversation
davidmyriel
commented
Oct 30, 2025
davidmyriel
commented
- fix grammar, spelling and semantics
- update headings
- add new copy to mirror website copy
- update product names
Please make sure all the checkboxes are checked:
|
WalkthroughThis PR rewrites Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolREADME.md[grammar] ~66-~66: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) [style] ~199-~199: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4250 characters long) (EN_EXCESSIVE_EXCLAMATION) 🔇 Additional comments (7)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @davidmyriel, thank you for submitting a PR! We will respond as soon as possible.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~76-~76: Ensure spelling is correct
Context: ...ree/main/cognee-starter-kit) ## About Cognee Cognee transforms your data into a livin...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~215-~215: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4029 characters long)
Context: ...welcome contributions from the community! Your input helps make Cognee better for...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
README.md
179-179: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (3)
README.md (3)
1-66: Navigation and messaging updates look good.The title, tagline, and navigation links have been refreshed to better communicate the product's value proposition. All links are properly formatted and the section hierarchy is clear.
69-95: Quickstart and About sections are well-organized.The renamed "Quickstart" section with bullet items provides clear entry points for users, and the revised "About Cognee" section effectively communicates key product features and deployment options.
183-234: Cognee Cloud, Community, and citation sections look good.The restructured Demos & Examples, Community & Support, and Research & Citation sections are well-formatted and clearly presented. All links are properly formatted.
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~66-~66: Ensure spelling is correct
Context: ... width="50%" /> ## About Cognee Cognee is an open source tool and platfo...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~68-~68: Use a hyphen to join words.
Context: ...div> ## About Cognee Cognee is an open source tool and platform that transforms...
(QB_NEW_EN_HYPHEN)
[style] ~97-~97: Consider using the synonym “brief” (= concise, using a few words, not lasting long) to strengthen your wording.
Context: ...p=sharing) ## Quickstart Let’s take a quick look at how Cognee works in just a few ...
(QUICK_BRIEF)
[style] ~198-~198: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4153 characters long)
Context: ...welcome contributions from the community! Your input helps make Cognee better for...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
README.md
72-72: No empty links
(MD042, no-empty-links)
155-155: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
163-163: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
174-174: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (3)
README.md (3)
1-31: Navigation and branding updates look good.The hero tagline, navigation links, and badge updates are well-executed and improve clarity around product positioning.
44-58: Updated value proposition is clear and well-positioned.The new introductory copy effectively communicates the ECL pipeline concept and differentiator. Language links are properly maintained.
178-217: Demos, Community, and Citation sections are well-structured.The reorganization of demos with clear headings, the new Community & Support section with clear calls-to-action, and the Research & Citation section with proper BibTeX formatting all follow documentation best practices.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
66-93: Fix empty and malformed links; apply hyphenation to "open source".Three critical Markdown syntax issues and one styling issue prevent correct rendering:
- Line 68: "open source" should be hyphenated as "open-source" for proper compound adjective styling.
- Line 72: Empty link—
[]()has nohref; add the documentation URL for the Self-host option.- Line 73: Double opening parenthesis in the Cognee Cloud link—
((https://...))is malformed; should be(https://...).- Line 91: Double opening parenthesis in the Colab walkthrough link—same syntax error; should be
(https://...).Apply this diff:
-Cognee is an open source tool and platform that transforms your raw data into persistent and dynamic AI memory for Agents. It combines vector search with graph databases to make your data both searchable by meaning and connected by relationships. +Cognee is an open-source tool and platform that transforms your raw data into persistent and dynamic AI memory for Agents. It combines vector search with graph databases to make your data both searchable by meaning and connected by relationships. You can use Cognee in two ways: -1. [Self-host Cognee Open Source](), which stores all data locally by default. -2. [Connect to Cognee Cloud]((https://platform.cognee.ai/)), and get the same OSS stack on managed infrastructure for easier development and productionization. +1. [Self-host Cognee Open Source](https://docs.cognee.ai/getting-started/installation/), which stores all data locally by default. +2. [Connect to Cognee Cloud](https://platform.cognee.ai/), and get the same OSS stack on managed infrastructure for easier development and productionization. ### Cognee Open Source (self-hosted): ... -To learn more, [check out this short, end-to-end Colab walkthrough]((https://colab.research.google.com/drive/12Vi9zID-M3fpKpKiaqDBvkk98ElkRPWy?usp=sharing)) of Cognee's core features. +To learn more, [check out this short, end-to-end Colab walkthrough](https://colab.research.google.com/drive/12Vi9zID-M3fpKpKiaqDBvkk98ElkRPWy?usp=sharing) of Cognee's core features.Note: The href placeholder
https://docs.cognee.ai/getting-started/installation/for the Self-host link should be updated to the correct documentation URL if different.
🧹 Nitpick comments (1)
README.md (1)
199-199: Consider moderating excessive exclamation marks.Line 199 contains multiple exclamation marks in a short span ("...from the community! Your input helps make Cognee better for everyone."). While not a blocker, reducing exclamation mark density to one per message improves tone consistency and readability.
Consider softening to:
-We welcome contributions from the community! Your input helps make Cognee better for everyone. +We welcome contributions from the community. Your input helps make Cognee better for everyone.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: topoteretes/cognee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-27T09:21:14.154Z
Learning: Use clear, imperative PR titles (≤ 72 chars) with conventional commit style; CI validates semantic PR titles
🪛 LanguageTool
README.md
[grammar] ~66-~66: Ensure spelling is correct
Context: ... width="50%" /> ## About Cognee Cognee is an open source tool and platfo...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~68-~68: Use a hyphen to join words.
Context: ...div> ## About Cognee Cognee is an open source tool and platform that transforms...
(QB_NEW_EN_HYPHEN)
[style] ~199-~199: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4205 characters long)
Context: ...welcome contributions from the community! Your input helps make Cognee better for...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
README.md
72-72: No empty links
(MD042, no-empty-links)
🔇 Additional comments (3)
README.md (3)
8-8: Well-executed branding and navigation updates.The hero tagline, navigation links, and badge URLs have been appropriately refreshed to reflect the updated product messaging and documentation structure. The additions of "Docs" and "Learn More" links improve discoverability.
Also applies to: 13-15, 21-21, 28-28, 44-44, 52-52
95-177: Code blocks, examples, and Quickstart section are well-structured.Language identifiers have been properly added to fenced code blocks (
bash,text, ```python), enabling correct syntax highlighting. The Quickstart section provides clear prerequisites, installation steps, LLM configuration, and CLI usage with appropriate examples.
179-218: Demos, Community & Support, and Citation sections are well-organized.The restructured sections ("Demos & Examples," "Community & Support," "Research & Citation") improve clarity and navigation. The content updates align with the PR objective of mirroring website copy and updating terminology.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
68-73: CRITICAL: Unresolved link issues from prior review—must be fixed before merge.Three previously flagged Markdown link defects persist:
- Line 72: Empty link—
[Self-host Cognee Open Source]()has no href; add a documentation URL.- Line 73: Malformed syntax—
[Connect to Cognee Cloud]((https://platform.cognee.ai/))has double opening paren; remove one.- Line 91: Malformed syntax—
[check out this short, end-to-end Colab walkthrough]((https://...has double opening paren; remove one.- Line 68: Style—"open source" should be hyphenated as "open-source" for proper grammatical styling.
Apply this diff:
-Cognee is an open source tool and platform that transforms your raw data into persistent and dynamic AI memory for Agents. It combines vector search with graph databases to make your documents both searchable by meaning and connected by relationships. +Cognee is an open-source tool and platform that transforms your raw data into persistent and dynamic AI memory for Agents. It combines vector search with graph databases to make your documents both searchable by meaning and connected by relationships. You can use Cognee in two ways: -1. [Self-host Cognee Open Source](), which stores all data locally by default. -2. [Connect to Cognee Cloud]((https://platform.cognee.ai/)), and get the same OSS stack on managed infrastructure for easier development and productionization. +1. [Self-host Cognee Open Source](https://docs.cognee.ai/getting-started/installation/), which stores all data locally by default. +2. [Connect to Cognee Cloud](https://platform.cognee.ai/), and get the same OSS stack on managed infrastructure for easier development and productionization. To learn more, [check out this short, end-to-end Colab walkthrough](https://colab.research.google.com/drive/12Vi9zID-M3fpKpKiaqDBvkk98ElkRPWy?usp=sharing) of Cognee's core features.Note: Update the href for the Self-host link if the documentation URL differs.
Also applies to: 91-91
🧹 Nitpick comments (1)
README.md (1)
199-199: Minor: Excessive exclamation mark density—consider moderating tone.Line 199 contains 7 exclamation marks across 4,213 characters, flagging stylistic excess per LanguageTool. Reword one or two sentences to use periods or downgrade enthusiasm slightly for a more measured professional tone, e.g.:
-We welcome contributions from the community! Your input helps make Cognee better for everyone. See [`CONTRIBUTING.md`](CONTRIBUTING.md) to get started. +We welcome contributions from the community. Your input helps make Cognee better for everyone. See [`CONTRIBUTING.md`](CONTRIBUTING.md) to get started.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: topoteretes/cognee PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-27T09:21:14.154Z
Learning: Use clear, imperative PR titles (≤ 72 chars) with conventional commit style; CI validates semantic PR titles
🪛 LanguageTool
README.md
[grammar] ~66-~66: Ensure spelling is correct
Context: ... width="50%" /> ## About Cognee Cognee is an open source tool and platfo...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~68-~68: Use a hyphen to join words.
Context: ...div> ## About Cognee Cognee is an open source tool and platform that transforms...
(QB_NEW_EN_HYPHEN)
[style] ~199-~199: Using many exclamation marks might seem excessive (in this case: 7 exclamation marks for a text that’s 4213 characters long)
Context: ...welcome contributions from the community! Your input helps make Cognee better for...
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.18.1)
README.md
72-72: No empty links
(MD042, no-empty-links)
🔇 Additional comments (2)
README.md (2)
1-64: Branding and header restructuring looks solid.Tagline updated ("Accurate & Persistent Memory for AI agents"), navigation reorganized (Docs and Learn More links added), community label clarified ("Community Plugins & Add-ons"), and badge metadata refreshed. These align well with the PR objectives.
44-44: Content and language refinements approved.Core description now emphasizes ECL pipelines over RAG (line 44), and translation link corrected (line 52). Changes support the documentation update goals.
Also applies to: 52-52
2 participants
