Skip to content

Task 01: Created ONBOARDING.md for excalidraw-app#17

Open
velnychukyuracv wants to merge 2 commits intokoldovsky:mainfrom
velnychukyuracv:documentation-onboarding
Open

Task 01: Created ONBOARDING.md for excalidraw-app#17
velnychukyuracv wants to merge 2 commits intokoldovsky:mainfrom
velnychukyuracv:documentation-onboarding

Conversation

@velnychukyuracv
Copy link
Copy Markdown

@velnychukyuracv velnychukyuracv commented Mar 25, 2026

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive developer onboarding guide covering project layout, tech stack, getting-started steps, development workflow and common commands, build/test/lint/format guidance, architecture overview (rendering, state, elements, collaboration, persistence), testing setup and mocks, environment variable usage, contribution patterns, code quality practices, token estimation methodology, troubleshooting, and links to further resources.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9c8dedcd-5f72-490a-8582-0b74103ba441

📥 Commits

Reviewing files that changed from the base of the PR and between 2e8bed4 and 330d591.

📒 Files selected for processing (1)
  • ONBOARDING.md
✅ Files skipped from review due to trivial changes (1)
  • ONBOARDING.md

📝 Walkthrough

Walkthrough

Adds a new ONBOARDING.md at the repository root containing a comprehensive developer onboarding guide covering repo layout, tech stack, getting started steps, development workflow, architecture, testing, tooling, environment variables, contribution tasks, and troubleshooting (documentation-only change).

Changes

Cohort / File(s) Summary
Developer Onboarding Documentation
ONBOARDING.md
Added a new, detailed onboarding document describing monorepo structure (packages/, excalidraw-app/, examples/), tech stack, setup commands (yarn, yarn start, yarn clean-install), development workflow (build/test/typecheck/lint/format), architecture overview (rendering pipeline, Jotai state, elements, collaboration), test config (Vitest/jsdom mocks), code quality tooling (ESLint/Prettier/Husky + lint-staged), Vite env var conventions, contribution steps, and troubleshooting resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through files to leave a sign,

A map for devs to follow the line.
Yarn commands neat and tests in view,
Welcome aboard — there’s much to do! 🥕

🚥 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 clearly summarizes the main change: adding a new ONBOARDING.md file. It is concise, specific, and directly reflects the primary purpose of the pull request.
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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 `@ONBOARDING.md`:
- Around line 325-329: The doc uses two different names for element grouping:
`groupId` in the "Key relationships" list but `groupIds` is defined elsewhere;
update the terminology so it's consistent (prefer using the defined `groupIds`)
by replacing `groupId` with `groupIds` in the Key relationships section and scan
for other occurrences of `groupId` to harmonize them; keep `id`, `frameId`, and
`startBinding`/`endBinding` unchanged.
- Around line 86-104: The fenced code block containing the project tree starting
with "excalidraw/" is unlabeled and triggers MD040; update the opening fence to
include a language (e.g., add "text" after the backticks) so the block becomes a
labeled fenced code block and satisfies markdownlint.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a08a8b75-37a4-4809-990d-653a1d9075c2

📥 Commits

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

📒 Files selected for processing (1)
  • ONBOARDING.md

@koldovsky
Copy link
Copy Markdown
Owner

approved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants