Nitrokey / nitrokey-documentation

User documentation of Nitrokey's products
https://docs.nitrokey.com
33 stars 41 forks source link

FIDO2: missing chapters from the main page #24

Closed szszszsz closed 3 years ago

szszszsz commented 3 years ago

Chapters from the main page are not shown in the left sidebar menu for Nitrokey FIDO2. These should be listed to allow user to move in the content.

image

ghost commented 3 years ago

there's a ToC now.

szszszsz commented 3 years ago

This seems to still occur - see #39

szszszsz commented 3 years ago

Ah, I see it right now. The chapters on the main page are not listed in the left menu, but only on the right. This has confused me, as I missed the new TOC completely. For me it might be more visible to duplicate it at the beginning of the page as well, but this might be personal bias. To discuss. image

jans23 commented 3 years ago

@szszszsz Can this be closed?

szszszsz commented 3 years ago

My main concern is still not corrected, which is that the main page chapters are not visible in the main tree, which would be intuitive for me. If I got confused, then I would expect some users would be as well, hence I would like to keep it open and solve it by either:

jans23 commented 3 years ago

For larger instructions combining headings into the left menu would be too confusing, I think. See for example this page.

szszszsz commented 3 years ago

I see your point. Then I think the Nitrokey FIDO2 main page should be divided to subpages so the mentioned Reset and other descriptions would be directly visible in the tree. Edit: then the main page would consist only of a short description and asking to choose the further topic from the tree on the left.

jans23 commented 3 years ago

I agree. The main page should contain all information which a new user should need to know, but not more. Hence, reset and other details can be moved to a different page.

szszszsz commented 3 years ago

Created #40 for further tasks regarding dividing main FIDO2 document to subpages. Closing this one as done by introducing TOC per document.