Skip to content

Replace usage of DescriptionList where not semantically correct #1010

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

Open
imiric opened this issue Jan 27, 2023 · 0 comments
Open

Replace usage of DescriptionList where not semantically correct #1010

imiric opened this issue Jan 27, 2023 · 0 comments
Labels
Area: OSS Content Improvements or additions to community/oss documentation

Comments

@imiric
Copy link
Contributor

imiric commented Jan 27, 2023

Currently we use our custom DescriptionList element in a few places:

As explained in this comment, this element is not appropriate to use simply because of its indented style. It makes semantic sense for the first 3 examples, since they are term definitions or short lists without much text, but not for the last 2, since these are not definitions or descriptions, but are used only because of the styling. If we need a similar style, we should create another custom element that wraps a title in a header element, and indent normal paragraphs following it with a bit of CSS.

This would generate much simpler semantic markup, wouldn't require fixes for issues like #1002, and would avoid the risk of any accessibility quirks.

@imiric imiric added the Area: OSS Content Improvements or additions to community/oss documentation label Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: OSS Content Improvements or additions to community/oss documentation
Projects
None yet
Development

No branches or pull requests

1 participant