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

Restructure ToC #105

Open
pcraig3 opened this issue Dec 11, 2024 · 1 comment
Open

Restructure ToC #105

pcraig3 opened this issue Dec 11, 2024 · 1 comment
Assignees
Labels
A11y This is an accessibility-related issue.

Comments

@pcraig3
Copy link
Collaborator

pcraig3 commented Dec 11, 2024

The TOC needs a little restructuring, but all the components are there which is fantastic!

I noticed all the links have a and the a nested , you don’t need both since it is just repetitive – you can just have

before after
TOC > TOCI > TOC > TOCI > Reference > Link > Link TOC > TOCI > Reference > Link
Image Image
@pcraig3 pcraig3 self-assigned this Dec 11, 2024
@pcraig3 pcraig3 added the A11y This is an accessibility-related issue. label Dec 11, 2024
@pcraig3
Copy link
Collaborator Author

pcraig3 commented Dec 17, 2024

Update to this issue now that we have talked it through.

Basically, I am not sure if this means we should create a flat hierarchy in our table of contents, or if the Sections themselves should be grouped along with their Subsection headings as a sublist.

Here is an illustration of the two alternatives.

Option 1 Option 2
flat list of ToC links "Step" headings are used to group links below them
Image Image

We are currently waiting on an answer back before we can get started on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A11y This is an accessibility-related issue.
Projects
None yet
Development

No branches or pull requests

1 participant