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

Proposal to improve charmhub documentation layout #1574

Open
taurus-forever opened this issue Apr 29, 2023 · 2 comments
Open

Proposal to improve charmhub documentation layout #1574

taurus-forever opened this issue Apr 29, 2023 · 2 comments

Comments

@taurus-forever
Copy link

Hi,

Please check the following picture:

Screenshot from 2023-04-30 00-00-41

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.

@Lukewh
Copy link
Contributor

Lukewh commented Nov 23, 2023

@juanruitina did you discuss these changes with the design team? @lyubomir-popov what are your thoughts?

@lyubomir-popov
Copy link
Contributor

lyubomir-popov commented Nov 23, 2023

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.

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

No branches or pull requests

3 participants