Add Excalidraw Onboarding Guide with setup, features, and workflow de…#29
Add Excalidraw Onboarding Guide with setup, features, and workflow de…#29alotofn0thing wants to merge 1 commit intokoldovsky:mainfrom
Conversation
📝 WalkthroughWalkthroughA new onboarding document for the Excalidraw TypeScript monorepo has been added, providing developers with core product context, repository structure guidance, a structured five-day onboarding plan, development workflow documentation, quality expectations, and AI-assisted exploration strategies. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (3)
EXCALIDRAW_ONBOARDING.md (3)
1-14: Clarify the target audience and repository context.The guide refers to "New Employees" (line 12) and uses employment-oriented framing ("onboarding"), but this document is in the
is-01-docsrepository, not the upstream Excalidraw repository. This creates ambiguity about who the guide is for.Consider adding a brief introductory section that clarifies:
- Is this for students/learners studying the Excalidraw codebase?
- Is this for contributors to a fork or training project?
- How does this relate to the upstream Excalidraw project?
This context will help readers understand how to apply the guidance, especially regarding contribution workflows and team expectations.
📝 Suggested introduction to add context
# Excalidraw Onboarding Guide +> **Note**: This guide is designed for [students/learners/contributors] studying the Excalidraw codebase as part of [course/project name]. While it references the upstream Excalidraw project, the workflow and expectations described here are tailored for this learning environment. + <div align="center"> <p> <strong>Virtual whiteboard for sketching hand-drawn like diagrams.</strong><br/>🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@EXCALIDRAW_ONBOARDING.md` around lines 1 - 14, The README's "What New Employees Should Know First" wording is ambiguous for this repo; add a short introductory section at the top of EXCALIDRAW_ONBOARDING.md clarifying the target audience (e.g., students/learners, contributors to a fork, or internal trainees), explain how this repository relates to the upstream Excalidraw project, and replace or augment the phrase "New Employees" with the appropriate audience term so contribution and workflow guidance (e.g., references to `excalidraw-app`, `packages`, PR/tests/CI) are correctly scoped to this repo's context.
103-110: Consider adding context for the token evaluation section.The token evaluation is well-calculated and useful, but readers unfamiliar with AI-assisted development might not immediately understand why token budgets are relevant to onboarding.
Adding a brief sentence explaining that these estimates help plan efficient AI-assisted exploration sessions (e.g., with ChatGPT, Claude, or other LLM tools) would improve clarity.
📝 Suggested context addition
## Token Evaluation (Onboarding Scope) -The estimates below help plan AI-assisted exploration sessions. +The estimates below help plan AI-assisted exploration sessions when using LLM tools (e.g., ChatGPT, Claude) to study the codebase, as these tools have context window limits measured in tokens. Method:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@EXCALIDRAW_ONBOARDING.md` around lines 103 - 110, Add a one-sentence explanation to the "Token Evaluation (Onboarding Scope)" section clarifying why token budgets matter for onboarding: explain that the Method/Approximation ("tokens ~= characters / 4") is intended to help plan efficient AI-assisted exploration sessions with LLM tools (e.g., ChatGPT, Claude) by guiding prompt/context sizing, not for exact billing—place this sentence immediately before or after the "Method:" block so readers unfamiliar with AI-assisted development understand the purpose.
73-77: Clarify the audience for knowledge handoff.Day 5 mentions sharing an "onboarding report," but doesn't specify who should receive it. Is this for:
- A course instructor or mentor?
- Team members in a collaborative learning environment?
- Personal documentation for self-paced learning?
Adding this clarification will help learners understand how to complete this step effectively.
💡 Suggested clarification
### Day 5 - Knowledge handoff -- Share a concise onboarding report: +- Share a concise onboarding report [with your mentor/instructor/team]: - explored modules,🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@EXCALIDRAW_ONBOARDING.md` around lines 73 - 77, Update the "Day 5 - Knowledge handoff" section to specify the intended audience for the onboarding report (e.g., "Instructor/Mentor", "Project Team", or "Personal Notes") and briefly state expectations per audience (for example: Instructor/Mentor — summarize learning outcomes and open technical questions; Project Team — include implementation details, delivered change, and action items; Personal Notes — concise summary for future reference). Ensure the phrase "onboarding report" and the bullet items (explored modules, delivered change, open technical questions) are retained but prefixed or annotated with the chosen audience labels so readers know who should receive each variant of the report.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@EXCALIDRAW_ONBOARDING.md`:
- Around line 1-14: The README's "What New Employees Should Know First" wording
is ambiguous for this repo; add a short introductory section at the top of
EXCALIDRAW_ONBOARDING.md clarifying the target audience (e.g.,
students/learners, contributors to a fork, or internal trainees), explain how
this repository relates to the upstream Excalidraw project, and replace or
augment the phrase "New Employees" with the appropriate audience term so
contribution and workflow guidance (e.g., references to `excalidraw-app`,
`packages`, PR/tests/CI) are correctly scoped to this repo's context.
- Around line 103-110: Add a one-sentence explanation to the "Token Evaluation
(Onboarding Scope)" section clarifying why token budgets matter for onboarding:
explain that the Method/Approximation ("tokens ~= characters / 4") is intended
to help plan efficient AI-assisted exploration sessions with LLM tools (e.g.,
ChatGPT, Claude) by guiding prompt/context sizing, not for exact billing—place
this sentence immediately before or after the "Method:" block so readers
unfamiliar with AI-assisted development understand the purpose.
- Around line 73-77: Update the "Day 5 - Knowledge handoff" section to specify
the intended audience for the onboarding report (e.g., "Instructor/Mentor",
"Project Team", or "Personal Notes") and briefly state expectations per audience
(for example: Instructor/Mentor — summarize learning outcomes and open technical
questions; Project Team — include implementation details, delivered change, and
action items; Personal Notes — concise summary for future reference). Ensure the
phrase "onboarding report" and the bullet items (explored modules, delivered
change, open technical questions) are retained but prefixed or annotated with
the chosen audience labels so readers know who should receive each variant of
the report.
1 participant
…tails
Summary by CodeRabbit