creativecommons / search

Creative Commons Search Portal
https://search.creativecommons.org/
MIT License
19 stars 114 forks source link

[Bug] Inconsistent HTML Structure in Search Portal #230

Closed Dev-JoyA closed 1 month ago

Dev-JoyA commented 1 month ago

Description

The search portal has an inconsistent HTML structure which affects accessibility and content organization.

Reproduction

  1. Open the repository for the search portal.
  2. Compare the HTML structure in the repository with the expected structure outlined in the Vocabulary documentation.
  3. Note that the structure is body > header > main instead of the expected body > main > header.

Expectation

The expected HTML structure should be body > main > header

Screenshot 2024-10-03 at 10 17 25

Environment

Device: Laptop OS: Windows 10 Browser: Chrome

Additional context

The implementation of the Vocabulary design system across the Creative Commons web entities has been inconsistent, leading to these structural issues. Addressing them is crucial for ensuring compliance with design standards and enhancing accessibility

Resolution

possumbilities commented 1 month ago

@Dev-JoyA I think some of your formatting didn't come through, it seems like you are referencing tags that aren't in the description of the Issue?

Dev-JoyA commented 1 month ago

@Dev-JoyA I think some of your formatting didn't come through, it seems like you are referencing tags that aren't in the description of

@Dev-JoyA I think some of your formatting didn't come through, it seems like you are referencing tags that aren't in the description of the Issue?

I will edit it and notify you, I will also do well to add screenshots for clarity

Dev-JoyA commented 1 month ago

@possumbilities there is no sidebar region in serach portal so the aside tag is unnecessary, i have edited the description, and this is the only issue left

possumbilities commented 1 month ago

@Dev-JoyA Thank you, I think is ready for work now.

possumbilities commented 1 month ago

After reviewing #287 and investigating further I believe this Issue was approved in error.

I think there might be a misunderstanding about the nature of this sturcture. There are two header elements present on most pages utilizing Vocabulary.

There is the Header - Global Area, and there is the Page Header - Region itself. Each of these relies on placement within a different context.

I'm closing this Issue and the related PR as the structure does in fact seem to reflect the correct implementation at this time.

Dev-JoyA commented 1 month ago

@possumbilities I totally agree , that was before you explained the concept of the two header to me .