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

Adjust primary navigation to remove "fundamentals" conflict and improve link/title consistency #60

Closed
6 tasks done
mcking65 opened this issue May 4, 2022 · 5 comments

Comments

@mcking65
Copy link
Contributor

mcking65 commented May 4, 2022

The goal of this issue is to resolve two problems with the primary navigation which includes links named Home, patterns and widgets, fundamentals, Index, and About.

Problem 1: The first link violates a primary principle of accessible navigation -- consistency in meaning between the text of a link and the title of the page targeted by the link. The first page is titled "Get empowered to create accessible rich internet applications" and the text of the first link is "Home". That title and link text are not sufficiently consistent in meaning.

Problem 2: As @shawna-slh pointed out in #34, the name "fundamentals" in the APG IA could eventually cause some confusion between APG and a similarly named section in the WAI site. While risk and impact is likely fairly low, it is something we can avoid altogether by choosing a different word.

Solution to Title/link name inconsistency

  • Change the H1 title on the home page to "ARIA Authoring Practices Guide Home".
  • Change text of first link in navigation to "APG Home"

Solution to conflict with WAI use of term "Fundamentals"

  • Change title in H1 of the Fundamentals page to "Practices"
  • Change link text in navigation to "Practices"

Multiple people, including most recently @richnoah, have suggested "practices" as an alternative to "Fundamentals". I originally dismissed this suggestion with the response that the entire site is "practices". But, after considerable thought, I think that is not necessarily the case. In addition to the fundamentals content, the other two primary elements of the guide are patterns, which are essentially abstract implementation of practices, and examples, which are the concrete implementation of practices. In other words, it is quite useful to think of the primary elements of the guide as patterns and examples that are based on practices.

Thinking of the IA this way, it is probably also to go a step further with the simplification and reduce "Patterns and Widgets" to "Patterns". On the patterns page, we regard every section as a pattern, regardless of whether that pattern is for an interactive widget or something else, e.g., an alert or table. We do not specifically name some of them as patterns and some as widgets. In fact, most of them are patterns for a widget. We do a good job in multiple places of helping people understand that.

So, I'd like to also suggest two more changes for this issue:

  • Change title in H1 of the Patterns and Widgets page to "Patterns"
  • Change link text in navigation from "Patterns and Widgets" to "Patterns"
@mcking65
Copy link
Contributor Author

Several items are addressed here; I checked them off.

I see an additional link at the end: All WCAG 2 Guidance. Please remove that link; it pretty severely breaks navigation consistency. I assume it is an artefact of the template of some kind? Can we fix that on our end, or do we need to have a change made to the template?

@isaacdurazo, the "Index" link feels out of place to me. It seems like we should have the two primary sections, patterns and practices, juxtaposed. What do you think of moving Index between practices and about?

Consider how I have described the APG structure in the new Introduction section:

The APG is organized into two major sections: patterns and practices. Each pattern explains how to make a common user interface element, such as a button, menu, or dialog, accessible, and provides functional example implementations of the pattern. The practices section gives in-depth explanation of how to satisfy a variety of accessibility needs that surface when making rich internet application experiences accessible. For instance, the practices section on providing accessible names and descriptions gives detailed descriptions of seven different naming techniques as well as a table providing guidance for naming more than 80 types of elements.

Also consider that the index page will eventually cover all content, not just examples.

@richnoah
Copy link

@mcking65 as I mentioned in an email earlier the site was experiencing issues and I had indicated to pause any review while it was being addressed. Alex jumped on after hours to resolve and the site is in good working order. Your above comment around the All WCAG Guidance has been removed.

@richnoah
Copy link

@mcking65 I would also like to see a separate issue raised for your ask of Isaac to consider changes to navigation as it is outside of the original scope of this issue and will hinder QA efforts if this is still In Progress for that work.

@mcking65
Copy link
Contributor Author

@richnoah wrote:

@mcking65 as I mentioned in an email earlier the site was experiencing issues and I had indicated to pause any review while it was being addressed. Alex jumped on after hours to resolve and the site is in good working order. Your above comment around the All WCAG Guidance has been removed.

thank you!!! Ya, things are looking awesome now. I have confirmed fixes for everything in the review column. And,I can confirm #62 now has addressed this issue as well. Moving to "in review".

@mcking65
Copy link
Contributor Author

Verified completely fixed by #62!! All to-do items now checked off!

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

2 participants