Add onboarding documentation for new developers#27
Open
iamalexndr wants to merge 2 commits intokoldovsky:mainfrom
Open
Add onboarding documentation for new developers#27iamalexndr wants to merge 2 commits intokoldovsky:mainfrom
iamalexndr wants to merge 2 commits intokoldovsky:mainfrom
Conversation
📝 WalkthroughWalkthroughAdded a comprehensive Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 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.
Actionable comments posted: 1
🧹 Nitpick comments (2)
ONBOARDING.md (2)
32-47: Add language specifications to fenced code blocks.The directory tree (lines 32-47) and dependency chain diagram (lines 53-60) should specify a language for better rendering and to satisfy markdown linters. Use
textfor these ASCII-art style diagrams.📝 Proposed fix for code block language specifications
For the directory tree at line 32:
-``` +```text excalidraw/ ├── packages/For the dependency chain at line 53:
-``` +```text `@excalidraw/excalidraw` ← main library, depends on everything below ├── `@excalidraw/common` ← foundational constants and utilitiesAlso applies to: 53-60
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@ONBOARDING.md` around lines 32 - 47, The fenced ASCII diagrams for the directory tree and dependency chain in the ONBOARDING.md file lack language tags; update those fenced code blocks (the excalidraw/ directory tree block and the `@excalidraw` dependency chain block) to use the "text" language specifier (i.e., change ``` to ```text) so markdown renderers and linters recognize them as plain text diagrams.
100-106: Add language specification to the data flow diagram.The data flow diagram should specify a language for the code fence. Use
textfor this type of ASCII diagram.📝 Proposed fix
-``` +```text User interaction (click, keypress, drag) → Action handler (packages/excalidraw/actions/)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@ONBOARDING.md` around lines 100 - 106, The fenced ASCII diagram block in ONBOARDING.md lacks a language tag; update the markdown code fence that contains the data flow diagram (the block starting with "User interaction (click, keypress, drag)") to use a language specifier `text` (i.e., change the opening ``` to ```text) so the diagram is explicitly marked as plain text.
🤖 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 68-72: ONBOARDING.md contains relative links that are broken in
this repository; update the doc so every reference to the Excalidraw codebase
uses absolute GitHub URLs (e.g.,
https://github.com/excalidraw/excalidraw/blob/main/...) instead of relative
paths, or move ONBOARDING.md into the Excalidraw repository so the existing
relative paths resolve; specifically search the file for all occurrences of
packages/excalidraw/* and excalidraw-app/* (and referenced filenames like
types.ts, editor-jotai.ts, App.tsx) and replace each with the corresponding
absolute GitHub blob URL (or relocate the file) ensuring links point to the main
branch.
---
Nitpick comments:
In `@ONBOARDING.md`:
- Around line 32-47: The fenced ASCII diagrams for the directory tree and
dependency chain in the ONBOARDING.md file lack language tags; update those
fenced code blocks (the excalidraw/ directory tree block and the `@excalidraw`
dependency chain block) to use the "text" language specifier (i.e., change ```
to ```text) so markdown renderers and linters recognize them as plain text
diagrams.
- Around line 100-106: The fenced ASCII diagram block in ONBOARDING.md lacks a
language tag; update the markdown code fence that contains the data flow diagram
(the block starting with "User interaction (click, keypress, drag)") to use a
language specifier `text` (i.e., change the opening ``` to ```text) so the
diagram is explicitly marked as plain text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+68
to
+72
| The editor's entire runtime state — the active tool, zoom level, pan offset, selected elements, current stroke color, whether the grid is on, and dozens of other properties — lives in a single `AppState` object defined in [packages/excalidraw/types.ts](packages/excalidraw/types.ts). This object is exposed as Jotai atoms, not passed through props or stored in a Redux slice. | ||
|
|
||
| The two relevant store files are: | ||
| - [packages/excalidraw/editor-jotai.ts](packages/excalidraw/editor-jotai.ts) — atoms for the library-level editor state | ||
| - [excalidraw-app/app-jotai.ts](excalidraw-app/app-jotai.ts) — atoms for app-specific state like collaboration and theme |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if the referenced file paths exist in the current repository structure
echo "=== Checking if excalidraw directory structure exists ==="
[ -d "packages/excalidraw" ] && echo "✓ packages/excalidraw exists" || echo "✗ packages/excalidraw NOT found"
[ -d "excalidraw-app" ] && echo "✓ excalidraw-app exists" || echo "✗ excalidraw-app NOT found"
echo -e "\n=== Sampling specific files referenced in the documentation ==="
files=(
"packages/excalidraw/index.tsx"
"packages/excalidraw/types.ts"
"packages/excalidraw/components/App.tsx"
"packages/excalidraw/editor-jotai.ts"
"excalidraw-app/App.tsx"
"packages/element/types.ts"
)
for file in "${files[@]}"; do
[ -f "$file" ] && echo "✓ $file exists" || echo "✗ $file NOT found"
done
echo -e "\n=== Repository identification ==="
git remote -v 2>/dev/null | head -2 || echo "No git remote found"Repository: koldovsky/is-01-docs
Length of output: 664
Convert file path references to absolute GitHub URLs or move documentation to Excalidraw repository.
This documentation contains relative file path references throughout (lines 68–72, 78–83, 90–91, 107–108, 152–155, 194–202) that assume the document lives in the Excalidraw repository root. However, it's being added to koldovsky/is-01-docs, a separate repository where none of these paths exist:
packages/excalidraw/— not foundexcalidraw-app/— not found- All referenced files (
types.ts,editor-jotai.ts,App.tsx, etc.) — not found
These links will be broken and unusable. Either:
- Convert all relative links to absolute GitHub URLs pointing to the Excalidraw repository (e.g.,
https://github.com/excalidraw/excalidraw/blob/main/packages/excalidraw/types.ts) - Move this documentation to the Excalidraw repository where relative links will work
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@ONBOARDING.md` around lines 68 - 72, ONBOARDING.md contains relative links
that are broken in this repository; update the doc so every reference to the
Excalidraw codebase uses absolute GitHub URLs (e.g.,
https://github.com/excalidraw/excalidraw/blob/main/...) instead of relative
paths, or move ONBOARDING.md into the Excalidraw repository so the existing
relative paths resolve; specifically search the file for all occurrences of
packages/excalidraw/* and excalidraw-app/* (and referenced filenames like
types.ts, editor-jotai.ts, App.tsx) and replace each with the corresponding
absolute GitHub blob URL (or relocate the file) ensuring links point to the main
branch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a developer onboarding guide covering project overview, tech stack,
monorepo architecture, key files, conventions, and a step-by-step first
steps section to help new contributors get up and running quickly
Summary by CodeRabbit