Skip to content

Redesign Roadmap Section for Enhanced Visual Appeal and Clarity #1364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

rishyym0927
Copy link
Contributor

Resolve #1361

Description:
This PR addresses the need for a more structured and visually engaging roadmap section on the About page. The previous layout was simple and lacked clear organization, making it difficult to convey the project's milestones and upcoming features effectively.

✨ What’s New

  • Redesigned the roadmap using a timeline layout for better structure.
  • Incorporated icons and color coding to visually distinguish between phases.

🧩 Motivation

The updated design aims to:

  • Enhance user experience by making the roadmap easier to read and interpret.
  • Provide clear insights into the project’s direction and progress.

📸 Screenshots (if applicable)

Recording.2025-04-14.034444.mp4

Copy link
Contributor

coderabbitai bot commented Apr 14, 2025

Summary by CodeRabbit

  • New Features

    • Introduced a visually enhanced Roadmap section displaying project milestones with icons, titles, and detailed descriptions.
    • Each roadmap item now includes a direct link to its related GitHub issue for further information.
  • Style

    • Improved the presentation of the About page by simplifying the layout and removing unnecessary markup for cleaner content display.
      """

Summary by CodeRabbit

  • New Features
    • Introduced an enhanced roadmap section that now showcases engaging visuals with icons, titles, detailed descriptions, and interactive links.
  • Refactor
    • Streamlined the presentation by consolidating the roadmap logic into a dedicated component, resulting in a cleaner and more maintainable layout.

Walkthrough

The changes refactor the roadmap section on the About page by removing the old inline rendering of roadmap items and replacing it with a dedicated Roadmap component. This new component manages the display logic, including the rendering of icons and additional descriptions for each roadmap item, which enhances the overall structure and visual appeal of the section.

Changes

Files Change Summary
frontend/src/app/about/page.tsx Simplified JSX by removing redundant wrappers around markdown content and repositioned imports related to error handling.
frontend/src/components/Roadmap.tsx Added a new Roadmap component that displays roadmap items with icons, titles, descriptions, and links in a responsive grid layout.
frontend/src/utils/aboutData.ts Enhanced roadmap data by adding icon, description, and detailedDescription properties to each roadmap item, importing icons from FontAwesome.

Assessment against linked issues

Objective Addressed Explanation
Refactor the Roadmap Section on About Page to enhance visual appeal and structure (#1361)

Suggested reviewers

  • kasya
  • arkid15r

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f54c03 and 249d858.

📒 Files selected for processing (1)
  • frontend/src/app/about/page.tsx (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • frontend/src/app/about/page.tsx

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

Let's try it in 2x3 layout (two columns) and remove the style effects as we don't have those anywhere else.

@rishyym0927
Copy link
Contributor Author

Hey @arkid15r,
I'll incorporate the two-column style as suggested. Could you please clarify what you meant by the removal of the style effect?

@rishyym0927
Copy link
Contributor Author

rishyym0927 commented Apr 14, 2025

Hey @arkid15r, I’ve removed the styling effect and switched it to a two-column layout. Check it out and let me know if anything else needs fixing—I’ll push the changes accordingly.

Recording.2025-04-14.223224.mp4

@rishyym0927 rishyym0927 requested a review from arkid15r April 14, 2025 17:01
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
frontend/src/components/Roadmap.tsx (3)

12-16: Consider using unique identifiers instead of array indices for keys.

Using the array index as a key prop might lead to unexpected behavior if the roadmap items order changes or items are added/removed dynamically.

-        {roadmap.map((item, index) => (
+        {roadmap.map((item) => (
           <div
-            key={index}
+            key={item.issueLink}
             className="flex flex-col justify-between border p-4 text-gray-600 dark:border-gray-700 dark:text-gray-300"

25-29: Remove unnecessary whitespace in JSX.

There's an unnecessary space character at line 26 that should be removed.

                <div className="h-3/4">
-                  {' '}
                  <h3 className="mb-1 text-lg font-semibold leading-snug">{item.title}</h3>
                  <p className="mb-4 line-clamp-3 text-sm">{item.detailedDescription}</p>
                </div>

26-28: Consider adding a tooltip or expandable view for truncated descriptions.

The line-clamp-3 will truncate longer descriptions, which might hide important information. Consider adding a way for users to view the full description.

                  <h3 className="mb-1 text-lg font-semibold leading-snug">{item.title}</h3>
-                  <p className="mb-4 line-clamp-3 text-sm">{item.detailedDescription}</p>
+                  <p className="mb-4 line-clamp-3 text-sm group relative">
+                    {item.detailedDescription}
+                    <span className="absolute invisible group-hover:visible bg-white dark:bg-gray-800 p-2 rounded shadow-lg text-sm max-w-xs z-10 top-full left-0 mt-1">
+                      {item.detailedDescription}
+                    </span>
+                  </p>
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 67bd0fc and 4f54c03.

📒 Files selected for processing (1)
  • frontend/src/components/Roadmap.tsx (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
frontend/src/components/Roadmap.tsx (2)
frontend/src/utils/aboutData.ts (1)
  • roadmap (16-67)
frontend/src/types/link.ts (1)
  • Link (1-6)
🔇 Additional comments (6)
frontend/src/components/Roadmap.tsx (6)

1-6: LGTM: Well-structured imports and client directive.

The imports are well-organized, importing only what's needed. The 'use client' directive is correctly placed at the top of the file to indicate client-side rendering in Next.js.


8-11: Component structure looks good.

The component is properly structured as a functional component using arrow function syntax. Wrapping the roadmap in a SecondaryCard provides consistent styling with the rest of the application.


11-12: Good responsive design implementation.

The grid layout changes from single column to two columns on medium screens and above, providing a better user experience across different device sizes.


17-23: Good visual hierarchy with icon implementation.

The icon implementation with the colored circular background creates a nice visual hierarchy and helps differentiate between different roadmap items.


31-41: Good accessibility implementation for GitHub links.

The GitHub issue links include proper aria-labels and hiding decorative icons from screen readers. This is excellent for accessibility.


1-52:

❓ Verification inconclusive

Verify integration with the About page.

Ensure this new component is properly integrated into the About page, replacing the previous roadmap implementation.


🏁 Script executed:

#!/bin/bash
# Check if the Roadmap component is imported and used in the About page
echo "Checking for Roadmap component usage in About page:"
fd "page.tsx" src/app/about | xargs grep -l "Roadmap" | xargs cat

Length of output: 277


Attention: Verify About Page Integration

Our automated search did not locate the About page at the expected path ("src/app/about"), so we couldn’t confirm that the new Roadmap component is being integrated appropriately. Please verify that:

  • The Roadmap component is imported and rendered within the actual About page.
  • The About page file exists at the correct location (e.g., it might be under a different path like /pages/about or in another folder within src/app).

If the About page path has changed, kindly update both the integration and the path used in the verification script accordingly.

Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

It seems you reverted the Roadmap changes on about page.

Copy link

Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

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

Please check my recent comment. Thank you!

@arkid15r arkid15r requested a review from aramattamara April 18, 2025 18:15
@arkid15r arkid15r marked this pull request as draft April 20, 2025 16:54
@arkid15r
Copy link
Collaborator

I don't see any recent progress on this, I'm going to reassign it if you're not interested.

@arkid15r
Copy link
Collaborator

Pinging here as well, should we keep it open?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor the Roadmap Section on About Page to Enhance Visual Appeal and Structure
2 participants