Onboarding documentation for the project

[am1re]

Summary by CodeRabbit

• Documentation
  • Added comprehensive developer onboarding docs covering project architecture, runtime flows (scene initialization, sharing/import/export, real-time collaboration), asset handling, build/test tooling, local development setup, feature-to-package guidance, and a prioritized first-PR roadmap with a minimal quality checklist.

[coderabbitai]

Warning

Rate limit exceeded

@am1re has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 36240981-c2d0-4a25-8433-0088c3fdedfa

📥 Commits

Reviewing files that changed from the base of the PR and between bddbfe8 and b646fa0.

📒 Files selected for processing (1)

• DEVELOPER_ONBOARDING_CONFLUENCE.md

📝 Walkthrough

Walkthrough

Added a Confluence-ready developer onboarding document that describes Excalidraw’s Yarn workspaces monorepo layout, enforced dependency boundaries, key runtime entry points and data/control flows (scene init, share/import/export, collaboration, assets), and the build/test/tooling plus a suggested first-PR path.

Changes

Cohort / File(s)

Summary

Developer Onboarding Documentation DEVELOPER_ONBOARDING_CONFLUENCE.md

New comprehensive onboarding page covering monorepo architecture and workspace boundaries, runtime entry points (packages/excalidraw/index.tsx, packages/excalidraw/components/App.tsx, excalidraw-app/...), scene initialization sources, share link pipeline (serialize → compress → encrypt → backend/URL hash → import/decrypt/decompress), collaboration websocket sync and room lifecycle, file/binary asset handling, build/test toolchain (Yarn v1 workspaces, Node ≥18, Vite, Vitest, ESLint/Prettier), common root commands, env expectations, module-selection guidance, a first-PR technical path, and an appendix with entry-point references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 I hopped through files and left a clue,

A map for builders, shiny and new,
Layers, links, and sync in view,
Pack your carrots — dive on through! 🥕✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Onboarding documentation for the project' is directly related to the main change: a new developer onboarding document has been added to the repository.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@DEVELOPER_ONBOARDING_CONFLUENCE.md`:
- Around line 51-331: The document uses top-level h2 (##) for both parent
sections and their subsections causing hierarchy break; update all subsection
headings to h3 (###) so they nest under their parent sections (e.g., change "##
Workspace Structure" under "## Monorepo and Package Boundaries", "## 1. Library
Entrypoint and Public Surface" under "## Runtime Architecture", and "## A. Scene
Initialization Flow" under "## Critical Data Flows" to use ###), and apply the
same change for all listed subsections (Runtime Architecture entries, Critical
Data Flows entries, Build and Test Infrastructure subsections, Local Development
subsections, First PR Path items, and Appendix high-value entry points) to
restore proper markdown hierarchy.
- Around line 80-331: The onboarding doc references many Excalidraw filenames
and config entries that don't exist in this repository (e.g.,
packages/excalidraw/index.tsx, packages/excalidraw/components/App.tsx,
excalidraw-app/index.tsx, excalidraw-app/collab/Collab.tsx, vitest.config.mts,
packages/element/src/index.ts, etc.); update the
DEVELOPER_ONBOARDING_CONFLUENCE.md by either (A) adding a clear note at the top
stating this is external/onboarding-for-a-different-repo and link to the correct
repository, or (B) removing/replacing all Excalidraw-specific sections with
accurate entry points and config names from this repo (use the actual root
package.json scripts, existing test config, and real package paths) so listed
symbols match the current codebase.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 88bda0bf-ab42-4d64-bebe-18b25bd1cc39

📥 Commits

Reviewing files that changed from the base of the PR and between be47f1d and a8aa9a2.

📒 Files selected for processing (1)

• DEVELOPER_ONBOARDING_CONFLUENCE.md