added onboarding.md

[ap-inventorsoft]

Summary by CodeRabbit

• Documentation
  • Added comprehensive local development onboarding guide including repository structure overview, step-by-step setup instructions with environment configuration, technical stack details, prerequisite requirements, common development commands for testing and linting, optional collaboration server setup, local documentation development guide, and troubleshooting checklist for typical onboarding issues.

[coderabbitai]

📝 Walkthrough

Walkthrough

Introduces a comprehensive onboarding guide document for the Excalidraw monorepo, detailing repository structure, development environment setup, technical stack overview, prerequisite requirements, step-by-step installation instructions, environment configuration, common commands, and troubleshooting checklist for developers.

Changes

Cohort / File(s)	Summary
Documentation onboarding.md	New comprehensive developer onboarding guide covering repository structure, tech stack (React 19, Vite, TypeScript, Vitest), setup instructions, environment configuration, development commands, optional collaboration setup, and common onboarding pitfalls checklist.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for the curious, a map for the lost,
Where packages and aliases help coders get across,
With Node and with Yarn, the journey begins,
From clone to first startup—let the magic set in! ✨

🚥 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 'added onboarding.md' accurately describes the main change—adding a new onboarding documentation file 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: 1

🧹 Nitpick comments (1)

onboarding.md (1)

109-110: Add a direct link to excalidraw-room setup docs.

“as described in its repository” is a bit indirect for first-time contributors. A direct URL here would reduce onboarding friction.

🤖 Prompt for AI Agents

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

In `@onboarding.md` around lines 109 - 110, Replace the vague "as described in its
repository" with a direct link to the excalidraw-room setup documentation by
editing the onboarding steps that mention "Set up the collab server:
`excalidraw-room`" and the line referencing `VITE_APP_WS_SERVER_URL`; update the
first bullet to read something like "Set up the collab server: `excalidraw-room`
(see <direct URL to excalidraw-room setup docs>)" so first-time contributors
have an explicit URL to follow.

🤖 Prompt for all review comments with AI agents

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

Inline comments:
In `@onboarding.md`:
- Line 7: Update the project description sentence to hyphenate compound
modifiers: change "open source" to "open-source" and "hand-drawn style" to
"hand-drawn-style" in the line that currently reads "Excalidraw is an open
source, hand-drawn style whiteboard with collaborative editing and export
options." so the compound adjectives are grammatically correct and consistent.

---

Nitpick comments:
In `@onboarding.md`:
- Around line 109-110: Replace the vague "as described in its repository" with a
direct link to the excalidraw-room setup documentation by editing the onboarding
steps that mention "Set up the collab server: `excalidraw-room`" and the line
referencing `VITE_APP_WS_SERVER_URL`; update the first bullet to read something
like "Set up the collab server: `excalidraw-room` (see <direct URL to
excalidraw-room setup docs>)" so first-time contributors have an explicit URL to
follow.

🪄 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: c5b83bb5-dfc6-4dfe-8c52-4e2300bdf578

📥 Commits

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

📒 Files selected for processing (1)

• onboarding.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Hyphenate compound modifiers in the project description.

At Line 7, use hyphenation for compound adjectives: open-source and hand-drawn-style to improve readability and grammar consistency.

🧰 Tools

🪛 LanguageTool

[grammar] ~7-~7: Use a hyphen to join words.
Context: ... Project Overview Excalidraw is an open source, hand-drawn style whiteboard with...

(QB_NEW_EN_HYPHEN)

---

[grammar] ~7-~7: Use a hyphen to join words.
Context: ...Excalidraw is an open source, hand-drawn style whiteboard with collaborative edit...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents

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

In `@onboarding.md` at line 7, Update the project description sentence to
hyphenate compound modifiers: change "open source" to "open-source" and
"hand-drawn style" to "hand-drawn-style" in the line that currently reads
"Excalidraw is an open source, hand-drawn style whiteboard with collaborative
editing and export options." so the compound adjectives are grammatically
correct and consistent.