chore(optimiser): Change UI to standardise the components #4267
Conversation
…d update color scheme
|
@thejus03 is attempting to deploy a commit to the modsbot's projects Team on Vercel. A member of the Team first needs to authorize it. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #4267 +/- ##
==========================================
+ Coverage 54.52% 56.55% +2.03%
==========================================
Files 274 299 +25
Lines 6076 6931 +855
Branches 1455 1672 +217
==========================================
+ Hits 3313 3920 +607
- Misses 2763 3011 +248 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
leslieyip02
left a comment
leslieyip02
left a comment
There was a problem hiding this comment.
Generally LGTM. I think the FAQ section could be useful, so I think we could add a couple more questions.
| display: block; | ||
| margin-top: 0.5rem; | ||
| font-weight: 600; | ||
| text-decoration: underline; |
There was a problem hiding this comment.
Personally I'm not a fan of the underlining here. These are headers so I feel that the bolding is sufficient.
| The optimiser will explore thousands of timetable combination amongst your | ||
| selected modules that meet your preferences and return an optimal one. |
There was a problem hiding this comment.
Typo: "The optimiser will explore thousands of timetable combinations amongst your selected modules that meet your preferences and return an optimal one."
There was a problem hiding this comment.
Actually maybe we could expand this to explain how to use the optimiser?
What is the Timetable Optimiser?
Having trouble planning your timetable? The optimiser explores thousands of possible timetable configurations to help you find one that best fits your preferences.
You can indicate your preferences in the form above, and hit "Optimise Timetable" to generate an optimised timetable. When you click the "Open Optimised Timetable" button, it will bring you to a new page with the optimised timetable. If the timetable looks good to you, click "Import" to update your timetable.
| <p className={styles.bodyText}> | ||
| The returned timetable will be optimised for the following preferences: | ||
| <ul> | ||
| <b className={styles.boldConstraint}>Hard constraints</b> | ||
| <li>No live lessons on your chosen free days</li> | ||
| <li>No live lessons outside your preferred time range</li> | ||
|
|
||
| <b className={styles.boldConstraint}>Soft constraints</b> | ||
| <li>Minimise travel distance between class venues</li> | ||
| <li>Prioritise lunch break within your preferred time range</li> | ||
| <li> | ||
| Prioritise having less than your chosen number of consecutive hours of study | ||
| </li> | ||
| </ul> | ||
| </p> |
There was a problem hiding this comment.
Maybe this could be a separate FAQ?
What does the optimiser prioritise?
While the optimiser will try to generate a timetable that matches your preferences as closely as possible, there are certain preferences that may be harder to meet (due to course schedules and conflicts).
When you submit your preferences, there will generate 2 types of constraints:
Hard Constraints
These constraints must be satisfied by the optimiser:
- No live lessons on your chosen free days
- No live lessons outside your preferred time range
Soft Constraints
These constraints may be loosened/ignored if it's not possible to generate a valid timetable:
- Minimise travel distance between class venues
- Prioritise lunch break within your preferred time range
- Prioritise having less than your chosen number of consecutive hours of study
| <span className={styles.toggleIcon}>{isOpen ? <ChevronUp /> : <ChevronDown />}</span> | ||
| </button> | ||
| </div> | ||
| <div |
There was a problem hiding this comment.
I think we can add 1 more FAQ:
What happens if the optimiser can't generate a suitable timetable?
If there happens to conflicts in your selected modules or your preferences, the optimiser will still try to generate a timetable for you. However, it will only generate a partial timetable. You may have to edit the time table manually in this case.
(add more if you want)
…ontainer and components, and add new styles
2 participants
Context