add onboarding

[olegdkma]

Summary by CodeRabbit

• Documentation

  • Added comprehensive team onboarding guide including project structure overview, step-by-step development setup procedures, recommended local workflows, and contribution guidelines.

• Chores

  • Improved development environment configuration to exclude IntelliJ IDEA workspace artifacts and local storage files.

[coderabbitai]

📝 Walkthrough

Walkthrough

Two non-functional changes have been added: IntelliJ IDEA IDE artifacts were added to the project's gitignore configuration, and a new comprehensive onboarding documentation guide was created for team members covering monorepo structure, development workflow, and package interactions.

Changes

Cohort / File(s)	Summary
IDE Configuration .idea/.gitignore	Added exclusions for IntelliJ IDEA workspace artifacts including shelf/, workspace.xml, httpRequests/, dataSources/, and dataSources.local.xml.
Documentation docs/onboarding.md	New comprehensive onboarding guide covering monorepo structure, first-week activities, local development workflow, package interactions, contribution guidance, and token distribution analysis across project areas.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A gitignore grows in the .idea space,
While docs bloom bright at a welcoming pace,
New team members shall find their way,
With onboarding guides to brighten their day! 🌱✨

🚥 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 'add onboarding' directly corresponds to the main change: adding a new comprehensive onboarding documentation file (docs/onboarding.md).
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)

docs/onboarding.md (1)

64-67: Use a non-mutating test command in the default validation flow.

At Line 65 and Line 74, yarn test:update is presented as a standard validation step. That command name conventionally implies updating snapshots/files, which is risky as a default onboarding instruction. Prefer a read-only test step (e.g., yarn test) and keep update commands as explicit, opt-in recovery steps.

Suggested doc tweak

- - `yarn test:update`
+ - `yarn test`
...
-    typecheck --> tests[Run yarn test:update]
+    typecheck --> tests[Run yarn test]

Also applies to: 73-75

🤖 Prompt for AI Agents

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

In `@docs/onboarding.md` around lines 64 - 67, Replace the mutating default
validation command `yarn test:update` with a non-mutating read-only test command
(e.g., `yarn test`) in the onboarding steps so the default flow does not change
snapshots/files; keep `yarn test:update` only as an explicit opt-in step
mentioned separately (update recovery or troubleshooting) and update any
occurrences of `yarn test:update` in the onboarding text to `yarn test` while
preserving the surrounding validation sequence and notes.

🤖 Prompt for all review comments with AI agents

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

Inline comments:
In `@docs/onboarding.md`:
- Line 5: Replace the phrase "hand-drawn style whiteboard" with a tighter
compound modifier such as "hand-drawn whiteboard" (or "hand-drawn-style
whiteboard") in the sentence that currently reads "Excalidraw is an open-source,
hand-drawn style whiteboard and diagramming tool. This monorepo contains both:"
so the wording is grammatically clear and consistent.

---

Nitpick comments:
In `@docs/onboarding.md`:
- Around line 64-67: Replace the mutating default validation command `yarn
test:update` with a non-mutating read-only test command (e.g., `yarn test`) in
the onboarding steps so the default flow does not change snapshots/files; keep
`yarn test:update` only as an explicit opt-in step mentioned separately (update
recovery or troubleshooting) and update any occurrences of `yarn test:update` in
the onboarding text to `yarn test` while preserving the surrounding validation
sequence and notes.

🪄 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: cb3c216b-a172-4e6d-9664-fc35c8d71cb0

📥 Commits

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

📒 Files selected for processing (2)

• .idea/.gitignore
• docs/onboarding.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Tighten compound-modifier wording for clarity.

Line 5 reads “hand-drawn style whiteboard.” Prefer “hand-drawn whiteboard” (or “hand-drawn-style whiteboard”) for cleaner grammar.

🧰 Tools

🪛 LanguageTool

[grammar] ~5-~5: Use a hyphen to join words.
Context: ...Excalidraw is an open-source, hand-drawn style whiteboard and diagramming tool. T...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents

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

In `@docs/onboarding.md` at line 5, Replace the phrase "hand-drawn style
whiteboard" with a tighter compound modifier such as "hand-drawn whiteboard" (or
"hand-drawn-style whiteboard") in the sentence that currently reads "Excalidraw
is an open-source, hand-drawn style whiteboard and diagramming tool. This
monorepo contains both:" so the wording is grammatically clear and consistent.