Currently KB articles have navigation/anchor links within articles that rely on manually adding IDs into the rich text editor. However, creating IDs in this way can allow for the possibility of duplicate IDs which is an accessibility error. Before we can strip IDs from the editor and block this issue from occurring, we need to find a new/better way of creating navigation within KB articles.
Considerations
Finding a way that is automatic rather than manual would make these appear and work more consistently, benefiting the user of the articles
These ToC section are only needed on longer articles (i.e. about 3 sections or more?) so we would want to consider a solution that wouldn't necessarily appear all of the time but could be modified to only appear when we wanted it to
Each H2 should generate a link in the ToC, but not other heading levels
Edmund and I had discussed a module where each paragraph could be what generates these links which could also work but I want to make sure that we make sure we consider other blocks in this option as well (i.e If we have a screen shot we need to add does that mess up the links/sections?)
Once the new navigation has been implemented, editors can be updated to strip IDs
Acceptance Criteria
[ ] Options for anchor links/navigation in KBs have been explored
[ ] Options proposed to Product
[ ] Determine best option based on UX, accessibility, editor experience and technical feasibility
Description
Currently KB articles have navigation/anchor links within articles that rely on manually adding IDs into the rich text editor. However, creating IDs in this way can allow for the possibility of duplicate IDs which is an accessibility error. Before we can strip IDs from the editor and block this issue from occurring, we need to find a new/better way of creating navigation within KB articles.
Considerations
Acceptance Criteria
Team
Please check the team(s) that will do this work.