Add onboarding guide for Excalidraw monorepo#32
Open
Sergio2k75 wants to merge 2 commits intokoldovsky:mainfrom
Open
Add onboarding guide for Excalidraw monorepo#32Sergio2k75 wants to merge 2 commits intokoldovsky:mainfrom
Sergio2k75 wants to merge 2 commits intokoldovsky:mainfrom
Conversation
Added file onboarding.md for task01
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded a new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 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: 3
🧹 Nitpick comments (1)
onboarding.md (1)
470-584: Repository token/performance analytics section is too brittle for onboarding.This section contains many hard-coded estimates and runtime/perf claims that will go stale quickly and can mislead new contributors. Consider removing it from onboarding or linking to a generated report/source-of-truth instead.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@onboarding.md` around lines 470 - 584, The "Repository Token Analysis" section (header "## Repository Token Analysis" in onboarding.md) contains brittle hard-coded estimates and runtime/perf claims—remove this static block or replace it with a short pointer to a generated report; specifically delete the entire token/performance tables and prose under the "Repository Token Analysis" header and instead add a one-line sentence linking to a generated artifact or CI report (e.g. "See repo-size report at <generated-report-link>") or an internal script (e.g. mention run-scripts/generate-repo-report) so the data is kept up-to-date; ensure no other references to the removed tables remain in onboarding.md and, if desired, add a note describing where/how contributors can obtain the current metrics.
🤖 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 41-53: Update the fenced code blocks in onboarding.md to include a
language tag (e.g., ```text or ```bash) on each opening fence to satisfy MD040
linting; specifically modify each block shown in the diff (the directory tree
examples and the other ranges noted) so the opening triple backticks become
```text (or ```bash where command examples appear) while leaving the block
content unchanged, ensuring all occurrences at the ranges 41-53, 118-192,
211-250, 254-286, 290-311, 337-355, and 391-424 are updated.
- Line 34: The document uses two conflicting phrases—“Local-first autosave” and
“Auto-saves to encrypted cloud”—so pick the correct autosave model and make the
wording consistent across the doc: replace the phrase "Local-first autosave"
(the short feature label) and the paragraph that currently reads "Auto-saves to
encrypted cloud" with a single, accurate description (either local-first with
optional cloud backup, or cloud-encrypted autosave) and update any other
occurrences of those phrases to match; ensure you edit the feature label and the
explanatory copy so they convey the same behavior and privacy expectations.
- Around line 364-380: Update the onboarding workflow to target the repository's
default branch by replacing references to "develop" with "main": update the
commands "git checkout develop", "git pull origin develop", and "git rebase
origin/develop" (and any related examples) so new contributors create and rebase
feature branches against "main" instead of "develop".
---
Nitpick comments:
In `@onboarding.md`:
- Around line 470-584: The "Repository Token Analysis" section (header "##
Repository Token Analysis" in onboarding.md) contains brittle hard-coded
estimates and runtime/perf claims—remove this static block or replace it with a
short pointer to a generated report; specifically delete the entire
token/performance tables and prose under the "Repository Token Analysis" header
and instead add a one-line sentence linking to a generated artifact or CI report
(e.g. "See repo-size report at <generated-report-link>") or an internal script
(e.g. mention run-scripts/generate-repo-report) so the data is kept up-to-date;
ensure no other references to the removed tables remain in onboarding.md and, if
desired, add a note describing where/how contributors can obtain the current
metrics.
🪄 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
+41
to
+53
| ``` | ||
| excalidraw/ | ||
| ├── packages/ # Core library packages (published to npm) | ||
| │ ├── excalidraw/ # Main React component library (@excalidraw/excalidraw) | ||
| │ ├── common/ # Shared utilities (@excalidraw/common) | ||
| │ ├── element/ # Element management (@excalidraw/element) | ||
| │ ├── math/ # Math utilities (@excalidraw/math) | ||
| │ └── utils/ # Export utilities (@excalidraw/utils) | ||
| ├── excalidraw-app/ # Full-featured web application (excalidraw.com) | ||
| ├── examples/ # Integration examples (NextJS, browser scripts) | ||
| ├── dev-docs/ # Developer documentation site | ||
| └── firebase-project/ # Firebase configuration for collaboration | ||
| ``` |
There was a problem hiding this comment.
Add fenced code block language tags to satisfy markdown lint.
These blocks are missing language identifiers (MD040), which will fail/dirty docs linting. Use text (or bash where applicable) on each fence opening line.
🧩 Proposed fix pattern
-```
+```text
excalidraw/
...
-```
+```Also applies to: 118-192, 211-250, 254-286, 290-311, 337-355, 391-424
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 41-41: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@onboarding.md` around lines 41 - 53, Update the fenced code blocks in
onboarding.md to include a language tag (e.g., ```text or ```bash) on each
opening fence to satisfy MD040 linting; specifically modify each block shown in
the diff (the directory tree examples and the other ranges noted) so the opening
triple backticks become ```text (or ```bash where command examples appear) while
leaving the block content unchanged, ensuring all occurrences at the ranges
41-53, 118-192, 211-250, 254-286, 290-311, 337-355, and 391-424 are updated.
Comment on lines
+364
to
+380
| # Step 1: Start from latest develop | ||
| git checkout develop | ||
| git pull origin develop | ||
|
|
||
| # Step 2: Create feature branch | ||
| git checkout -b feature/your-feature-name | ||
|
|
||
| # Step 3: Make commits with clear messages | ||
| git add . | ||
| git commit -m "feat: add new feature" | ||
| git commit -m "refactor: improve performance" | ||
| git commit -m "test: add coverage for feature" | ||
| git commit -m "docs: update README" | ||
|
|
||
| # Step 4: Keep branch updated | ||
| git fetch origin | ||
| git rebase origin/develop |
There was a problem hiding this comment.
Git workflow is likely targeting the wrong base branch.
Line 364 and Line 380 instruct contributors to use develop, but this PR targets main. New contributors may branch/rebase against a non-default branch.
🔧 Suggested update
-# Step 1: Start from latest develop
-git checkout develop
-git pull origin develop
+# Step 1: Start from latest main
+git checkout main
+git pull origin main
...
-git rebase origin/develop
+git rebase origin/main📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| # Step 1: Start from latest develop | |
| git checkout develop | |
| git pull origin develop | |
| # Step 2: Create feature branch | |
| git checkout -b feature/your-feature-name | |
| # Step 3: Make commits with clear messages | |
| git add . | |
| git commit -m "feat: add new feature" | |
| git commit -m "refactor: improve performance" | |
| git commit -m "test: add coverage for feature" | |
| git commit -m "docs: update README" | |
| # Step 4: Keep branch updated | |
| git fetch origin | |
| git rebase origin/develop | |
| # Step 1: Start from latest main | |
| git checkout main | |
| git pull origin main | |
| # Step 2: Create feature branch | |
| git checkout -b feature/your-feature-name | |
| # Step 3: Make commits with clear messages | |
| git add . | |
| git commit -m "feat: add new feature" | |
| git commit -m "refactor: improve performance" | |
| git commit -m "test: add coverage for feature" | |
| git commit -m "docs: update README" | |
| # Step 4: Keep branch updated | |
| git fetch origin | |
| git rebase origin/main |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@onboarding.md` around lines 364 - 380, Update the onboarding workflow to
target the repository's default branch by replacing references to "develop" with
"main": update the commands "git checkout develop", "git pull origin develop",
and "git rebase origin/develop" (and any related examples) so new contributors
create and rebase feature branches against "main" instead of "develop".
Sergio2k75
changed the title
small fixes
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.
Added file onboarding.md for task01
Summary by CodeRabbit