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

documentation hierarchy heading sizes h1 = h2 are confusing #1039

Closed
adrelanos opened this Issue Jun 27, 2015 · 2 comments

Comments

Projects
None yet
2 participants
@adrelanos
Member

adrelanos commented Jun 27, 2015

I was confused by the documentation layout. (Not addressing content here.)

Example:
https://www.qubes-os.org/doc/InstallNvidiaDriver/

The current hierarchy is:

-> Nvidia proprietary driver installation
-> RpmFusion packages
--> Download packages
--> Build kernel package
-> Manual installation
--> Userspace components
--> Kernel module
--> Configure Xorg

Legend:

  • -> stands for heading h1
  • --> stands for heading h2

Issue:

  • The headings h1 and h2 have (almost?) the same size.
  • Therefore it's non-obvious, that one is supposed to either follow RpmFusion packages or Manual installation. Not the whole page.

Possible solutions:

  • Can the size of h1 be increased and/or the size of h2 be decreased?
  • Put Nvidia proprietary driver installation highest in the hierarchy. For example Download packages would get h3. Is this possible?
  • Write a small introduction, that it's an either this or this, not both thing.
  • Add a or an automatic table of contents. That would make the hierarchy visible. Would jekyll-toc-generator work or do you already use some table of contents solution?
@unman

This comment has been minimized.

Show comment
Hide comment
@unman

unman Aug 16, 2015

Member

From the style sheet there's a 2px diff h1,h2 (and then in steps down to h6). It isnt clear.
I'd suggest making this difference,(and that between h2 and h3), larger, and keep the 2px drops down to h6.

Member

unman commented Aug 16, 2015

From the style sheet there's a 2px diff h1,h2 (and then in steps down to h6). It isnt clear.
I'd suggest making this difference,(and that between h2 and h3), larger, and keep the 2px drops down to h6.

@unman

This comment has been minimized.

Show comment
Hide comment
@unman

unman Aug 26, 2015

Member

Rewritten the NVidia page for clarity: included in pull request QubesOS/qubes-doc#30
Still looking at the style sheet : seems to me that 4px difference will do h1/h2/h3 and makes for a somewhat clearer layout. Does anyone actually go down to h6?

Member

unman commented Aug 26, 2015

Rewritten the NVidia page for clarity: included in pull request QubesOS/qubes-doc#30
Still looking at the style sheet : seems to me that 4px difference will do h1/h2/h3 and makes for a somewhat clearer layout. Does anyone actually go down to h6?

@unman unman referenced this issue in QubesOS/qubesos.github.io Sep 6, 2015

Merged

Change font sizes in h1-h6 for clarity #4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment