Update README.md #13
Merged
Update README.md #13
Conversation
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
Contributor
WalkthroughAn illustrative image was inserted into the README file directly after the introductory description of the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
15-16: Use a descriptive alt, make image responsive, and enable lazy-loadingCurrent alt is generic and fixed width/height can break on small screens. Suggest improving accessibility and responsiveness.
-<img width="1000" height="761" alt="image" src="https://github.com/user-attachments/assets/cce68a0d-baac-45c5-8b59-9e7999932e1c" /> +<img + src="https://github.com/user-attachments/assets/cce68a0d-baac-45c5-8b59-9e7999932e1c" + alt="Screenshot: rsbuild-plugin-arethetypeswrong output highlighting type issues" + style="max-width: 100%; height: auto;" + loading="lazy" +/>
15-16: Alternatively, use Markdown image syntax for portabilityGitHub and npm both render Markdown images well; they’ll naturally scale to container width.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: colinaaa
PR: colinaaa/rsbuild-plugin-arethetypeswrong#3
File: src/index.ts:49-51
Timestamp: 2025-08-10T09:28:46.764Z
Learning: In the rsbuild-plugin-arethetypeswrong project, Rslib is used to bundle the plugin, which means all imported dependencies (including `arethetypeswrong/core`) are bundled into the final output. Therefore, these dependencies can be placed in `devDependencies` rather than `dependencies` since they are only needed at build time, not at runtime for end users.
📚 Learning: 2025-08-10T09:28:46.764Z
Learnt from: colinaaa
PR: colinaaa/rsbuild-plugin-arethetypeswrong#3
File: src/index.ts:49-51
Timestamp: 2025-08-10T09:28:46.764Z
Learning: In the rsbuild-plugin-arethetypeswrong project, Rslib is used to bundle the plugin, which means all imported dependencies (including `arethetypeswrong/core`) are bundled into the final output. Therefore, these dependencies can be placed in `devDependencies` rather than `dependencies` since they are only needed at build time, not at runtime for end users.
Applied to files:
README.md
📚 Learning: 2025-08-10T16:24:02.647Z
Learnt from: colinaaa
PR: colinaaa/rsbuild-plugin-arethetypeswrong#12
File: pnpm-workspace.yaml:2-2
Timestamp: 2025-08-10T16:24:02.647Z
Learning: In the rsbuild-plugin-arethetypeswrong repository, test/**/package.json files should NOT be included in the pnpm workspace. The workspace should only contain the root package (packages: ['.']). The test directories contain test projects that are intentionally kept separate from the workspace.
Applied to files:
README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary by CodeRabbit