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

Better use of headings in Usage section #1064

Closed
wheresrhys opened this issue May 6, 2018 · 1 comment · Fixed by #1087
Closed

Better use of headings in Usage section #1064

wheresrhys opened this issue May 6, 2018 · 1 comment · Fixed by #1087

Comments

@wheresrhys
Copy link

I'd like to improve the headings in the Usage section of the docs to solve a few niggles:

  • github's markdown styles don't contrast very much with each other once you get past h3
  • Parameters is a subsection of a function's documentation and, as such, a heading rather than strong would be more semantic
  • It's difficult to see where one section of API docs ends and another begins (for libraries that have multiple top level exports/classes)

Specifically, the changes I propose are

  • Make API, Examples, Debug, Reporting Issues and LIcence into level 2 headings. It's debatable whether, semantically, these should live as subsections of Usage, but given the better UX when using higher level headings, it seems like a good call to prefer higher level headings where that choice can be made. A criticism of this is that arguably github should improve their low level heading styles, but I'm taking the pragmatic approach of trying to change one library rather than an entire website :-) . I will , nonetheless, raise the issue with github too
  • Promote subheadings of API by 1 level to follow the promotion of the main API heading
  • Make Parameters subheadings into proper headings instead of strong paragraphs
  • Add HR after each top level section of the API docs

See developit/unistore#88 for an example of what the changes would mean

Any thoughts?

@tmcw
Copy link
Member

tmcw commented May 6, 2018

🤔 Sure, I think that as long as this works well in-practice and improves readability, I'm all for it. Will need to take special care to make sure that the documentation readme isn't regressed, because I think it currently relies on all documentation output to be under an h2 and promoting individual sections to be at the h2 level will require a change in its splicing logic.

@wheresrhys wheresrhys changed the title Better usage of headings in Usage section Better use of headings in Usage section May 6, 2018
@tmcw tmcw closed this as completed in #1087 Jun 4, 2018
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

Successfully merging a pull request may close this issue.

2 participants