Added interactive CodeCanvas diagram for plane

[Abdullah85MBA]

Description

I reached out earlier this year about building a diagram for how plane works under the hood, and Parth expressed his interest, This PR adds the interactive diagram to the readme. CodeCanvas has proven to triple the speed of understanding complex codebase logic for software developers which means plane's contributors are going to have at least a 30% overall productivity boost.

Here is the generated diagram for plane grouped by the application's use-cases and their runtime data flows: Open plane's interactive diagram

I built code canvas to simulate a senior engineer who have been working on plane'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:

• The diagram is already generated for plane, completely free, no monthly subscription. Consider it as my contribution to help fellow contributors lower their context onboarding friction before they can start contributing.
• The diagram file is stored in the repository itself, so the readme link will only work after merging. Until then, you can view the diagram from the link I shared above.
• Read the 1 pager guide to learn how to refine simulations to capture specific codebase logics you might want to cover.
• I am aware the mapping to the source code is shiften a couple lines off in some cases, I am working on fixing the bug asap.
• You can reach me out anytime on discord discord.gg/t3ezMyMPqr

Type of Change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] Feature (non-breaking change which adds functionality)
• [ ] Improvement (change that would cause existing functionality to not work as expected)
• [ ] Code refactoring
• [ ] Performance improvements
• [x] Documentation update

Screenshots and Media (if applicable)

Test Scenarios

Summary by CodeRabbit

• Documentation
  • Added "How it works" section with interactive walkthrough and visual tutorial
  • Enhanced community engagement resources and support guidance
  • Added Security contact information
  • Expanded Contributing guidelines with additional resources
  • Added repository activity metrics and License information

[CLAassistant]

All committers have signed the CLA.

[coderabbitai[bot]]

Walkthrough

Documentation expanded in README with new sections explaining plane's architecture through an interactive walkthrough with an illustrative image, plus additions covering community support, security contact information, contributing guidelines, repository activity metrics, and licensing notice.

Changes

Cohort / File(s)	Summary
Documentation & Community Information README.md	Added "How does plane work under the hood?" section with interactive walkthrough, dataflow tutorial link, and illustrative image. Expanded with community support prompts, Security section with contact details, Contributing section with multiple guidance links, repository activity banner, and License notice.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation content only; no code logic or control flow changes
• Consistent README structure additions following existing patterns
• Content additions and formatting are straightforward

Poem

🐰 ✨

A readme that shines, now deeper and wide, With architecture secrets no longer to hide, Community gardens, security walls, License and guidance in these helpful halls, Hopping through docs, from coder to friend!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title "Added interactive CodeCanvas diagram for plane" directly corresponds to the primary change documented in the PR description and objectives. The author's main focus is introducing the CodeCanvas interactive diagram to the README with explanations of its benefits. The title is clear, concise, and specific, accurately capturing the core contribution without vague terminology or excessive detail.
Description Check	✅ Passed	The description is mostly complete and addresses the key sections of the template. It provides a detailed explanation of the CodeCanvas diagram and its value proposition, properly selects "Documentation update" as the type of change, and includes relevant screenshots. While the Test Scenarios section is empty and the References section is missing, these are less critical for a documentation update PR. The description effectively communicates the purpose and scope of the changes.

✨ Finishing touches

🧪 Generate unit tests (beta)

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Abdullah85MBA]

Hi, Just floating my PR. let me know if for any reason you are having trouble opening the diagram.