feat: Translate README into Portuguese #762
Conversation
Signed-off-by: Diego B Theuerkauf <[email protected]>
Signed-off-by: Diego B Theuerkauf <[email protected]>
Please make sure all the checkboxes are checked:
|
WalkthroughA new Portuguese-language README file ( Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant README.pt.md
participant Cognee Project
User ->> README.pt.md: Access documentation (in Portuguese)
README.pt.md ->> User: Display project overview, features, instructions, and links
User ->> Cognee Project: Follow setup and usage instructions
Cognee Project -->> User: Provides memory solution as described
Possibly related PRs
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (3)
README.pt.md (3)
28-29: Correct typo in Product Hunt URL parameter.
The query string usesutm_souceinstead ofutm_source, which may affect analytics tracking.- ?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cognee + ?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_source=badge-cognee
111-114: Specify a language for the output code block.
Adding a language (e.g.,textoroutput) improves syntax highlighting consistency.- ``` + ```text🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
111-111: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
117-118: Use consistent branch reference for visualization assets.
The link points to theadd-visualization-readmebranch instead ofmain. Consider updating to:- https://rawcdn.githack.com/topoteretes/cognee/refs/heads/add-visualization-readme/assets/graph_visualization.html + https://rawcdn.githack.com/topoteretes/cognee/refs/heads/main/assets/graph_visualization.html
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.pt.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.pt.md
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...
(UNPAIRED_BRACKETS)
[grammar] ~62-~62: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[typographical] ~132-~132: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...
(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
README.pt.md
111-111: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 9573981 | Triggered | Generic Password | dccde0b | .github/workflows/relational_db_migration_tests.yml | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
community/README.pt.md (3)
110-114: Specify language for output snippetThe fenced code block for sample output lacks a language identifier, leading to a markdownlint MD040 warning. Consider adding a language tag (e.g.,
text) for proper syntax highlighting:- ``` + ```text🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
111-111: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
130-142: Improve list formatting in “Demonstrações”The list items and their links are on separate lines, which can hinder readability. Merge the link into the same line as the list item, for example:
- 1. O que é memória de IA: - [Saiba mais sobre o cognee](...) + 1. O que é memória de IA: [Saiba mais sobre o cognee](...)🧰 Tools
🪛 LanguageTool
[typographical] ~132-~132: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...(UNPAIRED_BRACKETS)
143-146: Code of Conduct link text refinementThe link text shows
<code>CODE_OF_CONDUCT</code>but points toCODE_OF_CONDUCT.md. For clarity, consider including the.mdextension in the link text:- <code>CODE_OF_CONDUCT</code> + <code>CODE_OF_CONDUCT.md</code>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
community/graph_visualization_pt.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
community/README.pt.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
community/README.pt.md
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...
(UNPAIRED_BRACKETS)
[grammar] ~62-~62: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[typographical] ~132-~132: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...
(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
community/README.pt.md
111-111: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (12)
community/README.pt.md (12)
1-8: Header and logo section – approvedThe centered header markup and logo rendering with alt text are consistent with the original English README.
10-16: Demo, website, and community links – approvedThe localized links to the demo video, official site, and Discord render correctly.
20-29: Badges section – approvedAll GitHub shields and the Product Hunt badge are present and formatted correctly.
32-38: Project description and benefits – approvedThe Portuguese translation of the project description and embedded benefits image is accurate and clear.
🧰 Tools
🪛 LanguageTool
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...(UNPAIRED_BRACKETS)
44-50: Features list – approvedThe feature bullet points are well translated and formatted.
56-59: Contributing guidelines – approvedThe translation and link to
CONTRIBUTING.mdare correct and clear.
60-69: Installation instructions – approvedThe pip installation example and mention of other package managers are well translated.
🧰 Tools
🪛 LanguageTool
[grammar] ~62-~62: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...(GENERAL_NUMBER_AGREEMENT_ERRORS)
70-79: Basic usage setup – approvedEnvironment variable setup and
.envguidance are accurately translated.
82-109: Code example – approvedThe async example is correctly translated and formatted with a specified
pythoncode fence.
116-119: Graph visualization – approvedThe graph embed and browser link are correctly translated.
123-129: Architecture diagram – approvedThe conceptual architecture section is well translated and displays the diagram as intended.
147-156: Contributors & star history – approvedThe contributors section and star history graph are correctly implemented and translated.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
community/README.pt.md (1)
108-112: Specify the language for the output code block
The fenced block showing example output should include a language for syntax highlighting:- ``` + ```text🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
109-109: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
community/README.pt.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
community/README.pt.md
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...
(UNPAIRED_BRACKETS)
[grammar] ~60-~60: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[typographical] ~130-~130: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...
(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
community/README.pt.md
109-109: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (15)
community/README.pt.md (15)
1-4: Header and logo section
The HTML structure for the centered header and logo is correct and well-translated.
6-16: Introduction and primary links
The project tagline, demo/website/Discord links, and break tags are properly translated and formatted.
20-28: Badges section
All GitHub and Product Hunt badges are correctly rendered with valid URLs.
32-38: Project description and benefits image
The Portuguese translation of the introductory sentence and the embedded benefits graphic are accurate.🧰 Tools
🪛 LanguageTool
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...(UNPAIRED_BRACKETS)
44-50: Features list
The bullet points concisely mirror the English README’s feature list and are grammatically correct.
51-53: Quick start links
The Colab and starter-repo links are now consolidated into single URLs (broken link issue from prior commits has been resolved).
60-60: Verify the package managers list
The list mentions "uv" as a package manager, which may be a translation typo. In the English README it likely refers topipxor similar. Please confirm and update accordingly (e.g., pip, poetry, pipx).🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...(GENERAL_NUMBER_AGREEMENT_ERRORS)
68-77: Environment configuration example
The code snippet for settingLLM_API_KEYand the.env.templatelink are accurate and clear.
80-107: Python usage example
The full async example is correctly indented, translated, and demonstrates the default pipeline usage.
114-118: Verify the graph visualization asset path
The imagegraph_visualization_pt.pngis referenced via a relative path undercommunity/. Confirm that the file exists there or switch to an absolute URL (as used elsewhere):- <img src="graph_visualization_pt.png" ...> + <img src="https://raw.githubusercontent.com/topoteretes/cognee/main/assets/graph_visualization_pt.png" ...>
122-127: Architecture diagram section
The conceptual diagram and its centering HTML look correct and mirror the English README.
128-136: Verify demonstration links
The demo links point touser-attachmentsasset URLs. Please confirm these are publicly accessible and intended for the final README.🧰 Tools
🪛 LanguageTool
[typographical] ~130-~130: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...(UNPAIRED_BRACKETS)
141-145: Code of Conduct link
The absolute link toCODE_OF_CONDUCT.mdis correct and follows the English original.
145-150: Contributors section
The contrib.rocks badge is correctly embedded and localized.
151-154: Star history graph
The star-history badge is properly translated and linked.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
community/README.pt.md (3)
2-3: Use themainbranch for asset URLs
Referencing assets on thedevbranch may break if that branch is deleted or diverges. Consider pointing to themainbranch or a specific release tag for stability.- <img src="https://raw.githubusercontent.com/topoteretes/cognee/refs/heads/dev/assets/cognee-logo-transparent.png" alt="Cognee Logo" height="60"> + <img src="https://raw.githubusercontent.com/topoteretes/cognee/refs/heads/main/assets/cognee-logo-transparent.png" alt="Cognee Logo" height="60">
28-28: Fix typo in UTM parameter on Product Hunt badge
Theutm_souceparameter appears misspelled; it should beutm_sourceto ensure analytics capture correctly.- ?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-cognee + ?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_source=badge-cognee
108-108: Add language for output code block
Specify a language identifier for the fenced code block to improve readability and lint compliance (e.g.,textorconsole).- ``` + ```text🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
108-108: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
community/README.pt.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
community/README.pt.md
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...
(UNPAIRED_BRACKETS)
[grammar] ~59-~59: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[typographical] ~129-~129: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...
(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
community/README.pt.md
108-108: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (7)
community/README.pt.md (7)
34-34: This flagged unpaired bracket is a false positive; both link text and URL are properly enclosed.🧰 Tools
🪛 LanguageTool
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...(UNPAIRED_BRACKETS)
53-53: Validate quick start links
The Colab and starter repository links now appear on a single line and resolve correctly. Nice fix!
56-56: CONTRIBUTING.md link looks correct
The relative link now points to../CONTRIBUTING.md, which resolves from thecommunitydirectory.
59-59: Verify supported Python package managers
❓ The listpip,poetry,uvmay contain a typo—uvisn't a common Python package manager. Please confirm whether you intendedpipx,pip, or another tool.🧰 Tools
🪛 LanguageTool
[grammar] ~59-~59: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...(GENERAL_NUMBER_AGREEMENT_ERRORS)
83-83: Language specified for Python code block
Good job including thepythonlanguage specifier for the usage example, which enhances syntax highlighting.
129-131: Verify demo links under "Demonstrações"
The URLs point github.com/user-attachments/assets/..., which may be placeholders. Please confirm these links are correct and publicly accessible.🧰 Tools
🪛 LanguageTool
[typographical] ~129-~129: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...(UNPAIRED_BRACKETS)
142-142: Código de Conduta link is correctly absolute
Using the root-relative link/CODE_OF_CONDUCT.mdaligns with GitHub's URL structure and ensures it resolves properly from this location.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
community/README.pt.md (3)
53-53: Broken Colab link fixed
The Google Colab URL is now contained in a single line, ensuring the hyperlink works as expected.
57-57: Fix relative link to CONTRIBUTING.md
The link toCONTRIBUTING.mdnow uses an absolute path (/CONTRIBUTING.md), resolving the 404 issue.
143-143: Fix CODE_OF_CONDUCT link
The link toCODE_OF_CONDUCT.mduses an absolute path (/CODE_OF_CONDUCT.md), which is correct.
🧹 Nitpick comments (4)
community/README.pt.md (4)
8-8: Ensure brand consistency: capitalize project name
Consider updatingcogneetoCogneeto match the project's official branding and improve readability.
60-60: Clarify "uv" package reference
The termuvmight be unclear to users. If you meanuvicornor another installer, consider spelling it out or linking to its documentation.🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...(GENERAL_NUMBER_AGREEMENT_ERRORS)
79-79: Remove extra space before punctuation
There's an extra space before the period after the documentation link; remove it for cleaner markdown.
109-109: Add language identifier to fenced code block
Specify a language (e.g., ```text) for the output example to improve syntax highlighting and accessibility.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
109-109: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
community/README.pt.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
community/README.pt.md
[typographical] ~34-~34: Símbolo sem par: “]” aparentemente está ausente
Context: ...so](https://docs.cognee.ai/use-cases) e [avaliações](https://github.com/topoteret...
(UNPAIRED_BRACKETS)
[grammar] ~60-~60: Possível erro de concordância de número.
Context: ...uv ou qualquer outro gerenciador de pacotes Python. ### Com pip ```bash pip install cogn...
(GENERAL_NUMBER_AGREEMENT_ERRORS)
[typographical] ~130-~130: Símbolo sem par: “]” aparentemente está ausente
Context: ...emonstrações 1. O que é memória de IA: [Saiba mais sobre o cognee](https://githu...
(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
community/README.pt.md
109-109: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (1)
community/README.pt.md (1)
115-115: Verify existence of translated image
The filegraph_visualization_pt.pngis referenced here. Please ensure this image is added to the repository undercommunity/so the link doesn't break.
borisarzentar
changed the title
|
@diegoabt Thank you for this contribution! |
3 participants
Description
This branch contains the Portuguese translation of the README (
README.pt.md).Happy to work on any suggestions you may have.
DCO Affirmation
I affirm that all code in every commit of this pull request conforms to the terms of the Topoteretes Developer Certificate of Origin.