docs: improve README structure and readability#3515
Open
barnaclebot wants to merge 3 commits intomainfrom
Open
docs: improve README structure and readability#3515barnaclebot wants to merge 3 commits intomainfrom
barnaclebot wants to merge 3 commits intomainfrom
Conversation
- Add Quick Start and System Requirements sections - Add Privacy badge to badge section - Reorganize Features section by category (AI Model Support, User Experience, Content & Formatting, etc.) - Improve Contributing section with detailed contribution guidelines - Improve Development section with setup instructions, build commands, project structure, and troubleshooting
Contributor
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
- Fix project structure to match actual directory layout (src/main, src/renderer, src/preload, src/shared) - Correct linter name from ESLint to Biome - Correct test runner to Vitest - Fix troubleshooting tip (remove non-existent npm run clean)
The project has migrated to pnpm (packageManager: pnpm@10.15.1). Updated all npm references to pnpm including: - Prerequisites section - Quick Setup commands - Build Commands table - Development Tips - Troubleshooting section
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.
Summary
This PR improves the README structure and readability.
Changes
Benefits