Skip to content
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

Implemented Revamped FAQ Page #361

Merged
merged 5 commits into from
May 3, 2024
Merged

Implemented Revamped FAQ Page #361

merged 5 commits into from
May 3, 2024

Conversation

kea-roy
Copy link
Member

@kea-roy kea-roy commented Apr 14, 2024

Summary

Background

The FAQ page was never properly designed. After critique, the designers finalized a new layout and design for the FAQ page to match the style of our website and make it more convenient for the user. This Pull Request implements the revamped page based on the design on Figma.

Changes

This pull request made several component and layout changes to be more responsive and match the style of the page correctly.

  • Revamped styling of CollapsibleQuestion component to match Figma.
  • Revamped layout and styling of FAQ Page by switching to a grid layout.
  • Revamped index.tsx and App.tsx structure to allow for the removal of the footer when on the FAQ Page.
  • Added additional colors to colors.js.
  • Added documentation for CollapsibleQuestion and FAQ Page.
  • Tweaked style to be responsive so the design is correct for different screen sizes (mobile and desktop and tablet).

Test Plan

Tested the design for responsiveness by looking at different screen sizes and comparing it to the Figma

Desktop:

Code:
localhost_3000_faq(MacBook Air)
Figma:
FAQ Page  DESKTOP

Mobile:

Code vs Figma
localhost_3000_faq(iPhone SE) FAQ Page (MOBILE)

I also tested the other web pages to make sure my index.tsx and App.tsx modifications did not break any pages.

@dti-github-bot
Copy link
Member

dti-github-bot commented Apr 14, 2024

[diff-counting] Significant lines: 237.

@kea-roy kea-roy changed the title Implemented Revamped FAQ Page [WIP] Implemented Revamped FAQ Page Apr 17, 2024
@kea-roy kea-roy changed the title [WIP] Implemented Revamped FAQ Page Implemented Revamped FAQ Page Apr 24, 2024
@kea-roy kea-roy marked this pull request as ready for review April 24, 2024 04:47
Copy link
Contributor

@ggsawatyanon ggsawatyanon left a comment

Choose a reason for hiding this comment

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

Good job on this task, the styling looks great. I'm approving and merging your PR since it meets our functionality/visual requirements and we need it for the upcoming presentation. However, I want to highlight a few areas you should fix and create a new PR (and branch) for after this one is merged.

1. Naming convention
darkred: '#9C3B29',
You should change the name to red7 to match the other colors in the colors.js constants file. This is to keep the colors reusable and maintain our coding standards.

2. CollapsibleQuestion makeStyles definitions
For better code organization and performance, please move the makeStyles definitions outside of the component functions and place it directly below the import statements + Props. You can refer to our other pages such as LandlordPage and BookmarksPage for reference. This is because it also affects performance as every time the component is re-rendered, the styles also have to be re-calculated whereas if it is outside, it will be calculated only once and re-used.

3. FAQPage makeStyles definitions
Same as no. 2!

Other than these comments, good work!

@ggsawatyanon ggsawatyanon merged commit 5d848a4 into main May 3, 2024
5 checks passed
@ggsawatyanon ggsawatyanon deleted the revamped-faq-page branch May 3, 2024 19:34
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.

4 participants