Proposal to improve charmhub documentation layout
taurus-forever opened this issue · 2 comments
Hi,
Please check the following picture:
It is a real documentation of new PostgreSQL charm.
On the left side it is a current view, on the right side it is a proposal:
-
start titleing size from <h2> and not <h1>. The current font size <h1> is huge comparing to all other text on the page.
-
drop all margins and padding around the text. We are useng page space inefficient forcing people to scroll the page for nothing. Check the padding in a documentation menu, all elements are tight there.
@juanruitina did you discuss these changes with the design team? @lyubomir-popov what are your thoughts?
We've received similar requests from the documentation team. While I agree with the general direction (I even think we should limit titles to h4), we need to do a proper investigation to ensure readability, clear heading hierarchy when removing heading levels, etc, and potentially provide a separate set of heading styles for the documentation parts of our websites in vanilla.