Added interactive CodeCanvas diagram for cognee #1709
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Please make sure all the checkboxes are checked:
|
Contributor
WalkthroughThis PR adds a new "How does Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 @Abdulnaser97, thank you for submitting a PR! We will respond as soon as possible.
Removed extra blank lines before 'Self-Hosted (Open Source)' section.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
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(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
95-95: Link text should be descriptive
(MD059, descriptive-link-text)
97-97: Link text should be descriptive
(MD059, descriptive-link-text)
Comment on lines
+93
to
+99
| ### How does `cognee` work under the hood? | ||
|
|
||
| Check out this interactive walkthrough of the `cognee` codebase on CodeCanvas [here](https://www.code-canvas.com/?session=unauthenticatedGithub&repo=cognee&owner=topoteretes&branch=main&OnboardingTutorial=true). | ||
|
|
||
| To refine existing dataflow simulation or create new ones, follow the quick tutorial [here](https://docs.code-canvas.com/updating-diagram). | ||
|
|
||
| <img width="1916" alt="CodeCanvas Screenshot" src="https://codecanvas-media-public.s3.amazonaws.com/images/codecanvas-readme-screenshot.png" /> |
Contributor
There was a problem hiding this comment.
Improve link text descriptiveness for better accessibility.
Lines 95 and 97 use generic "here" link text, which violates markdown best practices (MD059). Consider rephrasing the links to be more descriptive of their content.
For example:
- Line 95: Instead of "here", link text could reference the specific walkthrough purpose (e.g., "interactive CodeCanvas walkthrough").
- Line 97: Instead of "here", link text could indicate the content (e.g., "CodeCanvas tutorial for refining diagrams").
This improves both readability and SEO while maintaining the section's clarity.
Apply this diff to improve link text:
-Check out this interactive walkthrough of the `cognee` codebase on CodeCanvas [here](https://www.code-canvas.com/?session=unauthenticatedGithub&repo=cognee&owner=topoteretes&branch=main&OnboardingTutorial=true).
+Check out this [interactive CodeCanvas walkthrough of the cognee codebase](https://www.code-canvas.com/?session=unauthenticatedGithub&repo=cognee&owner=topoteretes&branch=main&OnboardingTutorial=true).
-To refine existing dataflow simulation or create new ones, follow the quick tutorial [here](https://docs.code-canvas.com/updating-diagram).
+To refine existing dataflow simulation or create new ones, follow the [CodeCanvas tutorial for updating diagrams](https://docs.code-canvas.com/updating-diagram).🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
95-95: Link text should be descriptive
(MD059, descriptive-link-text)
97-97: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In README.md around lines 93 to 99, the two links use generic "here" text which
hurts accessibility and SEO; replace the link text on line 95 with a descriptive
phrase like "interactive CodeCanvas walkthrough" (so the link reads something
like Check out this interactive walkthrough of the `cognee` codebase on
CodeCanvas — interactive CodeCanvas walkthrough) and replace the link text on
line 97 with a descriptive phrase like "CodeCanvas tutorial for refining
diagrams" (so the quick tutorial link explicitly names the tutorial purpose);
keep the URLs and surrounding sentence structure unchanged.
Contributor
|
Thank you, won't be merged |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was trying to understand how
cogneeworks under the hood so I created a diagram for it using code-canvas.com. I think it will be pretty helpful for contributors to quickly onboard to the inner-works ofcognee.Here is the generated diagram for
cogneegrouped by the application's use-cases and their runtime data flows:Open cognee's interactive diagram
I built code canvas to simulate a senior engineer who have been working on
cognee's codebase for pretty long and can explain to you any functionality of the repository visually through diagrams.Here is what users are saying about codecanvas
"I used to spend 4 hours asking GPT how a use case in a codebase works and I keep going back and forth until I am able to draw a diagram to summarize my understanding,
CodeCanvas gives me that diagram in 40 seconds"
Some Notes:
cognee, completely free, no monthly subscription. Consider it as my contribution to help fellow contributors lower their context onboarding friction before they can start contributing.