Update README.mdFix README formatting and improve structure#2
Update README.mdFix README formatting and improve structure#2kunalbhardwaj2006 wants to merge 1 commit intoAOSSIE-Org:mainfrom
Conversation
github-actions
bot
added
no-issue-linked
documentation
WalkthroughThe README.md has been comprehensively updated to rebrand the project from "Dont Compete" to "LibrEd" and restructure the documentation with new sections on high-level architecture, core philosophy, and features, while revising getting started instructions and repository references. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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 |
|
Fixed formatting issues and improved README structure. Ready for review. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 113: Insert a single blank line immediately above the "## Project
Structure" heading so the markdown heading is separated from the previous
paragraph or block; specifically locate the line containing "## Project
Structure" and add one empty line before it to ensure correct Markdown
rendering.
- Line 75: Add a blank line after the "## Configuration" heading in README.md so
the heading is followed by an empty line; locate the "## Configuration" heading
and insert a single empty line immediately below it to conform to Markdown
formatting.
- Line 84: The README is missing a blank line after the heading "## Non-Coding
Contributions"; open the README.md and insert a single empty line immediately
following the "## Non-Coding Contributions" heading so that the heading is
separated from the following content and renders correctly.
- Line 48: Add a single blank line immediately after the "## Prerequisites"
heading in README.md so the heading is followed by an empty line before the next
content; locate the "## Prerequisites" heading and insert one newline after it
to comply with Markdown best practices.
- Line 94: Add a single blank line after the "## Testing" heading in README.md
so the heading is followed by an empty line before the next content; locate the
"## Testing" heading and insert one newline immediately after it to ensure
proper Markdown rendering.
- Line 6: Add a single blank line immediately before the heading "## High-Level
Architecture" in README.md so the heading is preceded by an empty line; locate
the line containing "## High-Level Architecture" and insert one newline above it
to follow Markdown best practices for proper rendering.
- Line 53: Add a single blank line immediately after the "## Quick Start"
heading in README.md so the heading is followed by an empty line before the next
content; locate the literal heading string "## Quick Start" and insert one blank
line below it to conform to Markdown heading spacing conventions.
- Line 55: Remove the duplicate malformed markdown list item "1. 1. **Clone the
repository**:" from the README (the extra copy present on the reported line);
ensure only the correctly formatted list entry "**Clone the repository**:"
remains (the original proper item on the previous line), so delete the duplicate
line and leave the surrounding list structure unchanged.
|
|
||
| **Dont Compete** is a purely local, containerized, and agent-driven platform for GATE (Graduate Aptitude Test in Engineering) preparation. It combines a modern React frontend with an autonomous backend pipeline that scrapes, classifies, and generates study materials from raw syllabus PDFs and local LLMs. | ||
| The system combines a modern React frontend with an automated backend pipeline that processes, classifies, and generates educational assets. | ||
| ## High-Level Architecture |
There was a problem hiding this comment.
Add blank line before heading.
Missing blank line above the "## High-Level Architecture" heading. Markdown best practices require blank lines around headings for proper rendering and readability.
📝 Proposed fix
The system combines a modern React frontend with an automated backend pipeline that processes, classifies, and generates educational assets.
+
## High-Level Architecture📝 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.
| ## High-Level Architecture | |
| The system combines a modern React frontend with an automated backend pipeline that processes, classifies, and generates educational assets. | |
| ## High-Level Architecture |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 6-6: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 6, Add a single blank line immediately before the heading
"## High-Level Architecture" in README.md so the heading is preceded by an empty
line; locate the line containing "## High-Level Architecture" and insert one
newline above it to follow Markdown best practices for proper rendering.
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
| ## Prerequisites |
There was a problem hiding this comment.
Add blank line after heading.
Missing blank line after the "## Prerequisites" heading. This violates markdown best practices and may affect rendering.
📝 Proposed fix
## Prerequisites
+
* [Docker Desktop](https://docs.docker.com/get-docker/) or Docker Engine + Compose.🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 48-48: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 48, Add a single blank line immediately after the "##
Prerequisites" heading in README.md so the heading is followed by an empty line
before the next content; locate the "## Prerequisites" heading and insert one
newline after it to comply with Markdown best practices.
| <!-- * [Git LFS](https://git-lfs.github.com/). --> | ||
|
|
||
| ### Quick Start | ||
| ## Quick Start |
There was a problem hiding this comment.
Add blank line after heading.
Missing blank line after the "## Quick Start" heading.
📝 Proposed fix
## Quick Start
+
1. **Clone the repository**:📝 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.
| ## Quick Start | |
| ## Quick Start | |
| 1. **Clone the repository**: |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 53-53: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 53, Add a single blank line immediately after the "##
Quick Start" heading in README.md so the heading is followed by an empty line
before the next content; locate the literal heading string "## Quick Start" and
insert one blank line below it to conform to Markdown heading spacing
conventions.
| git clone https://github.com/imxade/dont-compete.git | ||
| cd dont-compete | ||
| ``` | ||
| 1. 1. **Clone the repository**: |
There was a problem hiding this comment.
Fix duplicate and malformed list item.
Line 55 contains a duplicate and incorrectly formatted list item: "1. 1. Clone the repository:". This appears to be a copy-paste error that will break the markdown list rendering. This line should be removed entirely, as the proper list item already exists on line 54.
🐛 Proposed fix
1. **Clone the repository**:
- 1. 1. **Clone the repository**:
-🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 55-55: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 3
(MD005, list-indent)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 55, Remove the duplicate malformed markdown list item "1.
1. **Clone the repository**:" from the README (the extra copy present on the
reported line); ensure only the correctly formatted list entry "**Clone the
repository**:" remains (the original proper item on the previous line), so
delete the duplicate line and leave the surrounding list structure unchanged.
| ``` | ||
|
|
||
| ### Configuration | ||
| ## Configuration |
There was a problem hiding this comment.
Add blank line after heading.
Missing blank line after the "## Configuration" heading.
📝 Proposed fix
## Configuration
+
Central configuration is managed in `generator/src/config.py`. You can customize:📝 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.
| ## Configuration | |
| ## Configuration | |
| Central configuration is managed in `generator/src/config.py`. You can customize: |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 75-75: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 75, Add a blank line after the "## Configuration" heading
in README.md so the heading is followed by an empty line; locate the "##
Configuration" heading and insert a single empty line immediately below it to
conform to Markdown formatting.
| We are building a free, high-quality platform for everyone, and we need your help to achieve that! | ||
|
|
||
| ### Non-Coding Contributions | ||
| ## Non-Coding Contributions |
There was a problem hiding this comment.
Add blank line after heading.
Missing blank line after the "## Non-Coding Contributions" heading.
📝 Proposed fix
## Non-Coding Contributions
+
AI is a powerful accelerator, but it's not perfect. We rely on the community to ensure quality and depth.📝 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.
| ## Non-Coding Contributions | |
| ## Non-Coding Contributions | |
| AI is a powerful accelerator, but it's not perfect. We rely on the community to ensure quality and depth. |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 84-84: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 84, The README is missing a blank line after the heading
"## Non-Coding Contributions"; open the README.md and insert a single empty line
immediately following the "## Non-Coding Contributions" heading so that the
heading is separated from the following content and renders correctly.
| * **Expand Scope**: PRs adding support for **other competitive exams** are highly welcome! Let's build a universal free platform together. | ||
|
|
||
| ### Testing | ||
| ## Testing |
There was a problem hiding this comment.
Add blank line after heading.
Missing blank line after the "## Testing" heading.
📝 Proposed fix
## Testing
+
The project includes a comprehensive test suite that runs in Docker.📝 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.
| ## Testing | |
| ## Testing | |
| The project includes a comprehensive test suite that runs in Docker. |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 94-94: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 94, Add a single blank line after the "## Testing" heading
in README.md so the heading is followed by an empty line before the next
content; locate the "## Testing" heading and insert one newline immediately
after it to ensure proper Markdown rendering.
| /bin/sh -c "npm install && npx playwright test" | ||
| ``` | ||
| *Note: Ensure the frontend service is running (`docker compose up`) before starting Playwright tests.* | ||
| ## Project Structure |
There was a problem hiding this comment.
Add blank line before heading.
Missing blank line above the "## Project Structure" heading.
📝 Proposed fix
*Note: Ensure the frontend service is running (`docker compose up`) before starting Playwright tests.*
+
## Project Structure🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 113, Insert a single blank line immediately above the "##
Project Structure" heading so the markdown heading is separated from the
previous paragraph or block; specifically locate the line containing "## Project
Structure" and add one empty line before it to ensure correct Markdown
rendering.
1 participant
Addressed Issues:
Fixes #(issue number)
Screenshots/Recordings:
Additional Notes:
Checklist
We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact.
Summary by CodeRabbit
Documentation