Skip to content

Added interactive CodeCanvas diagram for cognee #1709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Abdulnaser97 wants to merge 3 commits into from
Closed

Added interactive CodeCanvas diagram for cognee #1709

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f2684b
CodeCanvas: Save
Abdulnaser97 Oct 30, 2025
efb4305
Add CodeCanvas diagram to README
Abdulnaser97 Oct 30, 2025
9a1af2c
Clean up README.md by removing blank lines
Abdulnaser97 Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ Self-hosted package:
Hosted platform:
- Includes a managed UI and a [hosted solution](https://www.cognee.ai)

### 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" />
Comment on lines +93 to +99
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.





## Self-Hosted (Open Source)
Expand Down
8,333 changes: 8,333 additions & 0 deletions cognee.CodeCanvas
View file
Open in desktop

Large diffs are not rendered by default.