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

Home page builder retains deleted content and semantics #65

Closed
mcking65 opened this issue May 7, 2022 · 4 comments
Closed

Home page builder retains deleted content and semantics #65

mcking65 opened this issue May 7, 2022 · 4 comments

Comments

@mcking65
Copy link
Contributor

mcking65 commented May 7, 2022

This is important for launch.

When the w3c/aria-practices/index.html file
is processed to build the content/index.md file , it is including deleted content and re-arranging content. I may be trying to have it do something it was not designed to do, however the fallback in this scenario is itself concerning me, especially keeping content that was deleted. I'll describe the two issues I have noticed related to keeping deleted content and deleted semantics. Then, I'll describe the end goal I am hoping to achieve.

Incorrectly retained deleted content

In APG pull 2309,
I removed lines 37-40 from the index.html file. Yet, after the PR was merged and the APG site was built and other changes in that PR are rendered, the content from those lines is still on lines 49-53 in
content/index.md:

49        <p>
50            Learn how to make common rich internet application patterns and
51            widgets accessible by applying WAI-ARIA roles, states and
52            properties, and implementing keyboard support.
53          </p>

Retained deleted semantics

In APG PR 2312,
I changed the H3 on line 35 to a paragraph. However, the H3 remains on line 48 of
content/index.md.
Since I didn't specify content for that H3, the code duplicated the content from the subsequent H3.

47        <h2>APG Resources</h2>
48        <h3>Design Patterns and Widgets</h3>
49        <p>Building blocks that help you make the web accessible</p>

What I'd like to get

The design has an H2 that titles each section of cards, e.g., <h2>APG Resources</h2>.
That H2 is followed by 2 elements of content before the first card, an H3, and a paragraph.
Because each card is an H3, this creates a confusing experience for a screen reader user.
The content in the paragraph is not really adding value, so I'd like to have only one content element after the section title. That element would be a short paragraph. For example, the desired rendering for the APG resources section is:

<h2>APG Resources</h2>
<p>Building blocks that help you make the web accessible</p>

That would then be followed by the H3 for the first card.

I'd like to have this reduced format for all sections after APG resources as well.

@richnoah
Copy link

richnoah commented May 9, 2022

@mcking65 the issue stems from the fact that the build was looking for an H3. We will be removing the H3 and will be using the H2 followed by the p tag. After the PR lands, there will have to be visual styling updates as the current H2 and p tags are very similar and do not offer enough visual distinction for sighted users.

@richnoah
Copy link

H3 has been removed. Styling of H2 and P elements is still needed.

@isaacdurazo
Copy link
Member

isaacdurazo commented May 11, 2022

Styling of h2 elements has been addressed in this commit

@mcking65
Copy link
Contributor Author

Just from inspecting current state of files, I think this is fixed. The final test will happen after #62 is merged to main, and after I merge the PR to update the content in the first paragraph under the first H2 (APG Resources).

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

No branches or pull requests

3 participants