Skip to content

Fix comments heading order#8876

Merged
andreslucena merged 2 commits intodecidim:developfrom
mainio:fix/comments-heading-order
Feb 24, 2022
Merged

Fix comments heading order#8876
andreslucena merged 2 commits intodecidim:developfrom
mainio:fix/comments-heading-order

Conversation

@ahukkanen
Copy link
Copy Markdown
Contributor

@ahukkanen ahukkanen commented Feb 22, 2022

🎩 What? Why?

The comments section heading order is illogical.

Also, the comments main heading should be a <h3> in the Decidim default layout for it to be logical compared to most of the contexts where the comment section is displayed in the Decidim default layout.

Currently e.g. on this page:
https://meta.decidim.org/processes/RedesignDecidim/f/1662/posts/235

The current <h4> level indicates that the comments section is a subsection of the last text section titled "Methodology: Open design / participated design". The correct top-level context of the comments section should be the blog article's title which is <h2> and therefore <h3> makes more sense for the comments section.

Many screen reader users users glance the page quickly by going through its headings in which case this can be confusing.

WCAG 2.2 / 1.3.1 Info and Relationships (Level A)

https://www.w3.org/TR/WCAG22/#info-and-relationships
https://www.w3.org/WAI/WCAG22/Understanding/info-and-relationships.html

📌 Related Issues

Testing

Give the linked blog page to a visually impaired user and ask them to read it.

📋 Checklist

  • CONSIDER adding a unit test if your PR resolves an issue.
  • ✔️ DO check open PR's to avoid duplicates.
  • ✔️ DO keep pull requests small so they can be easily reviewed.
  • ✔️ DO build locally before pushing.
  • ✔️ DO make sure tests pass.
  • ✔️ DO make sure any new changes are documented in docs/.
  • ✔️ DO add and modify seeds if necessary.
  • ✔️ DO add CHANGELOG upgrade notes if required.
  • ✔️ DO add to GraphQL API if there are new public fields.
  • ✔️ DO add link to MetaDecidim if it's a new feature.
  • AVOID breaking the continuous integration build.
  • AVOID making significant changes to the overall architecture.

@ahukkanen ahukkanen marked this pull request as draft February 23, 2022 08:55
@ahukkanen
Copy link
Copy Markdown
Contributor Author

I converted this to draft for now because of some inconsistencies I found with the heading orders right now in Decidim. E.g. in debates, the debate title is a <h2> but in proposals, the proposal heading is <h3>. So right now it depends on the context which heading order is correct for the comments section.

In order to merge this, we need to solve first the issue with the process subtitle I raised at the related discussion:
#8893 (comment)

@ahukkanen
Copy link
Copy Markdown
Contributor Author

The process/participatory space subtitle issue will be solved by #8901.

After that PR is merged, I'll merge with develop and mark this ready for review.

@ahukkanen ahukkanen marked this pull request as ready for review February 23, 2022 13:59
@ahukkanen
Copy link
Copy Markdown
Contributor Author

So since this keeps the build green, we should first merge this before the other fixes.

Both #8901 and #8877 require this to be merged first.

@andreslucena Can you take a look at this PR before those other PRs, so that we can keep the build green while merging these?

@andreslucena andreslucena merged commit 93ccf0a into decidim:develop Feb 24, 2022
@andreslucena
Copy link
Copy Markdown
Member

Can you please backport to v0.26-stable 🙏🏽? Thanks

@ahukkanen ahukkanen deleted the fix/comments-heading-order branch February 24, 2022 08:12
ahukkanen added a commit to mainio/decidim that referenced this pull request Mar 2, 2022
@ahukkanen
Copy link
Copy Markdown
Contributor Author

Backport at #8950.

@alecslupu alecslupu added this to the 0.27.0 milestone Jul 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants