docs: improve README with homepage preview#357
Open
naishakilaru-ai wants to merge 1 commit into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughThe README.md marketing content is refreshed across three sections: the project introduction gains an "About InternHack" heading area, the Tech Stack table is relabeled with updated terminology and version references, and the Features section for Students, Recruiters, and Admins are rewritten with new bullet phrasing and renamed feature items. ChangesREADME.md Content Refresh
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 39-42: The README duplicates role headings (e.g., "For Students"
and "Features for Students") and mixes heading levels under the "Features"
section; keep a single, consistent heading per role (choose either "For
Students", "For Instructors", "For Admins" etc.) at the same level (e.g., use
"### For Students") and remove the duplicate "## Features for X" lines so that
all role subsections are uniform under the main "## Features" section; update
the other duplicated pairs ("For Instructors"/"Features for Instructors", "For
Admins"/"Features for Admins") to the same pattern.
- Around line 19-22: Remove the duplicated markdown heading by deleting the
second occurrence of "## Tech Stack" so only a single "## Tech Stack" header
remains; locate the repeated heading string "## Tech Stack" in the README and
remove the extra instance to fix the duplicate-heading lint error and restore
proper document structure.
- Around line 3-4: The intro line mixes the tagline and a malformed heading
token ("A## About InternHack"); fix it by separating the tagline "**Prepare.
Practice. Placed.**" onto its own line and replacing "A## About InternHack" with
a proper Markdown heading "## About InternHack" on the following line (remove
the stray "A"). Ensure there is a blank line between the tagline and the heading
for correct rendering.
🪄 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
+3
to
+4
| **Prepare. Practice. Placed.**, A## About InternHack | ||
|
|
Contributor
There was a problem hiding this comment.
Fix malformed heading markup in the intro.
Line 3 currently concatenates tagline text and a heading token (A## About InternHack), which renders incorrectly.
Proposed fix
-**Prepare. Practice. Placed.**, A## About InternHack
+**Prepare. Practice. Placed.**
+
+## About InternHack📝 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
| **Prepare. Practice. Placed.**, A## About InternHack | |
| **Prepare. Practice. Placed.** | |
| ## About InternHack |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 3 - 4, The intro line mixes the tagline and a
malformed heading token ("A## About InternHack"); fix it by separating the
tagline "**Prepare. Practice. Placed.**" onto its own line and replacing "A##
About InternHack" with a proper Markdown heading "## About InternHack" on the
following line (remove the stray "A"). Ensure there is a blank line between the
tagline and the heading for correct rendering.
Comment on lines
19
to
+22
| ## Tech Stack | ||
|
|
||
| | Layer | Technology | | ||
| |-------|-----------| | ||
| | Frontend | React 18, Vite 7, TailwindCSS 4, React Router 7, Framer Motion, Zustand, React Query | | ||
| | Backend | Express 5, TypeScript 5, Prisma 7 | | ||
| | Database | PostgreSQL | | ||
| | AI | Google Gemini (`gemini-2.5-flash`) | | ||
| | Auth | JWT + Google OAuth | | ||
| | Payments | Dodo Payments | | ||
| | Storage | AWS S3 (with local fallback) | | ||
| | Email | Resend | | ||
| ## Tech Stack | ||
|
|
Contributor
There was a problem hiding this comment.
Remove duplicated Tech Stack heading.
Line 21 repeats ## Tech Stack immediately after Line 19, triggering duplicate-heading lint and cluttering structure.
Proposed fix
## Tech Stack
-
-## Tech Stack📝 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
| ## Tech Stack | |
| | Layer | Technology | | |
| |-------|-----------| | |
| | Frontend | React 18, Vite 7, TailwindCSS 4, React Router 7, Framer Motion, Zustand, React Query | | |
| | Backend | Express 5, TypeScript 5, Prisma 7 | | |
| | Database | PostgreSQL | | |
| | AI | Google Gemini (`gemini-2.5-flash`) | | |
| | Auth | JWT + Google OAuth | | |
| | Payments | Dodo Payments | | |
| | Storage | AWS S3 (with local fallback) | | |
| | Email | Resend | | |
| ## Tech Stack | |
| ## Tech Stack |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 21-21: Multiple headings with the same content
(MD024, no-duplicate-heading)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 19 - 22, Remove the duplicated markdown heading by
deleting the second occurrence of "## Tech Stack" so only a single "## Tech
Stack" header remains; locate the repeated heading string "## Tech Stack" in the
README and remove the extra instance to fix the duplicate-heading lint error and
restore proper document structure.
Comment on lines
39
to
+42
| ### For Students | ||
|
|
||
| - **Job Board**: Browse recruiter-posted jobs with search, filters, tags, and one-click apply | ||
| - **External Jobs**: Curated listings from external sources, updated regularly | ||
| - **AI Job Agent**: Chat-based AI assistant that finds jobs matching your profile and skills | ||
| - **ATS Resume Scorer**: Upload resume + JD, get an AI-powered match score with keyword gap analysis | ||
| - **Cover Letter Generator**: AI-generated cover letters tailored to specific job postings | ||
| - **AI Resume Builder**: Generate professional LaTeX resumes with AI assistance | ||
| - **Mock Interviews**: Practice with AI-driven interview simulations | ||
| - **Learning Hub**: 3,300+ DSA problems, SQL practice, aptitude questions, and 500+ lessons across 12 technologies | ||
| - **Skill Tests**: Timed assessments with auto-grading and verified skill badges | ||
| - **Career Roadmaps**: Guided paths for Full-Stack, Frontend, Backend, Data Science, DevOps, and more | ||
| - **Company Explorer**: Reviews, ratings, salaries, HR contacts, and open positions | ||
| - **Application Tracker**: Track applications from applied through hiring rounds to offer | ||
| - **Open Source Guide**: Step-by-step guides for reading codebases and contributing to OSS | ||
|
|
||
| ## Features for Students | ||
|
|
Contributor
There was a problem hiding this comment.
Normalize role subsection heading hierarchy.
The section currently duplicates each role heading (### For X + ## Features for X) and also breaks heading levels under ## Features. Keep one heading per role at a consistent level.
Proposed fix
## Features
-### For Students
-
-## Features for Students
+### For Students
...
-### For Recruiters
-
-## Features for Recruiters
+### For Recruiters
...
-### For Admins
-
-## Features for Admins
+### For AdminsAlso applies to: 56-59, 68-71
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 39 - 42, The README duplicates role headings (e.g.,
"For Students" and "Features for Students") and mixes heading levels under the
"Features" section; keep a single, consistent heading per role (choose either
"For Students", "For Instructors", "For Admins" etc.) at the same level (e.g.,
use "### For Students") and remove the duplicate "## Features for X" lines so
that all role subsections are uniform under the main "## Features" section;
update the other duplicated pairs ("For Instructors"/"Features for Instructors",
"For Admins"/"Features for Admins") to the same pattern.
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.
Description
Improved README documentation by enhancing readability and adding structured feature sections.
Changes Made
Summary by CodeRabbit