Skip to content

Content: Improve Quick Start page guidance for new learners (#92)#141

Open
coolss21 wants to merge 2 commits into
Demon-Die:mainfrom
coolss21:feature/issue-92
Open

Content: Improve Quick Start page guidance for new learners (#92)#141
coolss21 wants to merge 2 commits into
Demon-Die:mainfrom
coolss21:feature/issue-92

Conversation

@coolss21

@coolss21 coolss21 commented Jun 10, 2026

Copy link
Copy Markdown

Resolves #92

Overview
This PR refactors the Quick Start page (/docs/quick-start/page.tsx) to provide actionable guidance for learners, rather than an outdated code preview component.

Why this helps
The previous page featured a code-editing preview that was largely irrelevant for learners looking for guidance on how to use the site's roadmaps. This change provides clear, step-by-step instructions for getting started.

Changes included

  • Replaced the "Hello DemonTech" code preview with 4 core steps: "Choose Your Roadmap", "Navigate the Topics", "Study the Resources", and "Build Projects".
  • Swapped the interactive documentation features section with a new "Tips for Success" section focused on consistency and seeking help.

Summary by CodeRabbit

  • Documentation
    • Redesigned Quick Start page with a step-by-step "Choose Your Roadmap" sequence (steps 1–4)
    • Added a "Tips for Success" area with three guidance cards
    • Added an in-text link to All Roadmaps
    • Removed the interactive code example and tabbed preview
    • Streamlined page controls, leaving only a dark-mode toggle visible

@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

@rhoggs-bot-test-account is attempting to deploy a commit to the Rishi Bhardwaj's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a8e2ff2e-a275-4688-a4e1-16db97a01c76

📥 Commits

Reviewing files that changed from the base of the PR and between 1002752 and 0649e71.

📒 Files selected for processing (1)
  • project/src/app/docs/quick-start/page.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
  • project/src/app/docs/quick-start/page.tsx

📝 Walkthrough

Walkthrough

The quick-start page was redesigned to help new learners navigate the roadmap site. The previous tabbed code-example UI and feature-highlight section were removed. They are replaced with a four-step guided pathway for choosing a roadmap and a motivational tips section to encourage learning.

Changes

Quick Start Page Content Redesign

Layer / File(s) Summary
Remove old interactive UI data and state
project/src/app/docs/quick-start/page.tsx
Deleted the interactiveFeatures mock-data array and the activeTab React state variable that managed the previous tabbed code-example UI, simplifying the component to manage only dark-mode state.
Add step-by-step roadmap-choice guidance
project/src/app/docs/quick-start/page.tsx
Introduced a new "Choose Your Roadmap" bordered step-card section (steps 1–4) with sequential copy that walks learners through selecting and following a roadmap, including an in-text link to the "All Roadmaps" page.
Add success tips motivational cards
project/src/app/docs/quick-start/page.tsx
Added a new "Tips for Success" section with three centered motivational cards ("Be Consistent", "Ask Questions", "Trust the Process") to encourage learner commitment.

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A roadmap made clear, step by guided step,
Old code tabs retire, tips help you prep,
Four simple signposts on the learning way—
"Trust the process," we all say!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: improving the Quick Start page with better guidance for new learners, which aligns with the PR's primary objective.
Linked Issues check ✅ Passed The PR successfully addresses all coding objectives from issue #92: clearer onboarding content with four-step guidance, Tips for Success section, clear instructions for choosing roadmaps and progressing through topics, and preserved layout/style.
Out of Scope Changes check ✅ Passed All changes are directly scoped to issue #92 requirements: only the Quick Start page was modified to improve new learner guidance with no extraneous alterations.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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 `@project/src/app/docs/quick-start/page.tsx`:
- Line 357: The JSX text nodes contain unescaped apostrophes (e.g., "Don't")
which trigger react/no-unescaped-entities; update each offending string in
project/src/app/docs/quick-start/page.tsx (the text nodes near the <Link
href="/docs/all-roadmaps" ...> and the other occurrences at the same pattern) to
escape the apostrophe either by using HTML entity &apos; (e.g., Don&apos;t) or
by wrapping the text in a JS string expression (e.g., {"Don't"}), ensuring all
occurrences on the reported lines are fixed so the linter/build stops failing.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bdffba98-6eaf-4e47-af1a-e8384b97ddc2

📥 Commits

Reviewing files that changed from the base of the PR and between cb4c939 and 1002752.

📒 Files selected for processing (1)
  • project/src/app/docs/quick-start/page.tsx

Comment thread project/src/app/docs/quick-start/page.tsx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve the quick start page for new learners

1 participant