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

New syllabus generator error solved and fixed name styling issue #211

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

AaronSosaRamos
Copy link

@AaronSosaRamos AaronSosaRamos commented Dec 28, 2024

Description

This PR addresses and resolves multiple issues related to the Syllabus Generator and the UI. The changes include:

  1. Fixed the errors in the outputs generated by the Syllabus Generator to align with the new update.
  2. Enhanced the style and presentation of the Syllabus results for improved readability and user experience.
  3. Resolved an overlapping issue between the name and the logout icon in the navbar.

These updates aim to improve functionality and provide a better user interface.

Related Issue

Any

Type of Change

Please select the type(s) of change that apply and delete those that do not.

  • Bug fix: A non-breaking change that fixes an issue.
  • Code style update: Changes that do not affect the meaning of the code (e.g., formatting).
  • New feature: A non-breaking change that adds functionality.
  • Breaking change: A change that causes existing functionality to not work as expected.
  • Documentation update: Changes or updates to documentation.
  • Refactoring: A code change that neither fixes a bug nor adds a feature.
  • Performance improvement: A change that improves performance.
  • Test enhancement: Adding or updating tests; no production code change.
  • Chore: Changes to the build process or auxiliary tools; no production code change.
  • Other: (please describe)

Proposed Solution

  1. Updated the logic of the Syllabus Generator to ensure the outputs comply with the updated requirements.
  2. Applied CSS and design improvements to enhance the style and presentation of the generated Syllabus results.
  3. Adjusted the layout and resolved the z-index issue in the navbar to fix the overlapping of the name and logout icon.

Syllabus Generator:
image
image
image
image
image
image
image
image
image
image
image

History:
image
image
image
image
image
image

Old name style with the overlapping issue:
image

New name style without overlapping the logout button:
image

How to Test

  1. Syllabus Generator Output Testing:

    • Use the Syllabus Generator with various inputs.
    • Verify that the outputs meet the updated requirements and are error-free.
  2. Style and Presentation Testing:

    • Check the generated Syllabus results.
    • Ensure the styling is consistent and visually improved compared to the previous version.
  3. Navbar Overlap Testing:

    • Navigate to pages where the navbar is present.
    • Confirm that the name and logout icon no longer overlap and are displayed correctly.

Unit Tests

  • Added/modified tests for the Syllabus Generator logic to verify compliance with the updated outputs.
  • Visual regression tests for the Syllabus results to validate style changes.
  • UI tests for the navbar to ensure layout adjustments work as expected.

Documentation Updates

Indicate whether documentation needs to be updated due to this PR.

  • Yes
  • No

If yes, describe what documentation updates are needed and link to the relevant documentation.

Checklist

  • I have performed a self-review of my code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • Any dependent changes have been merged and published in downstream modules.

Additional Information

No additional information is required at this time. Feedback is welcome to ensure optimal implementation.

@AaronSosaRamos AaronSosaRamos added type:enhancement For minor updates or changes that improve an existing feature or process. type:refactoring For tasks focused on improving code structure, readability, or maintainability without changing its frontend This issue is primarly front-end focused labels Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
frontend This issue is primarly front-end focused type:enhancement For minor updates or changes that improve an existing feature or process. type:refactoring For tasks focused on improving code structure, readability, or maintainability without changing its
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant