Re: Usability ideas: text width and headers that are links

From: "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>
To: Niels Bom <niels(at)nielsbom(dot)com>, pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: Usability ideas: text width and headers that are links
Date: 2022-10-21 15:42:08
Message-ID: 283a08f1-ae00-8a96-db7c-dbd43bb53aae@postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Hi,

Thanks for the suggestions. Comments inline:

On 10/21/22 9:54 AM, Niels Bom wrote:
> Hi!
>
> I have 2 small ideas to improve the usability of the PostgreSQL documentation. I'm looking at v15 (1) mostly.
>
> Idea 1:
> Give the text width of the main content a max width.

Why? Can you please provide examples? Screenshots are OK.

> Idea 2:
> Each h3 and h4 element should be a link pointing to the nearest parent section with an id. This makes deeplinking to specific parts of a page easier. This prevents people from having to scroll to the top, find out which table-of-content-link they have to click to get the deeplink of where they wanted to link. This is actually quite a common pattern. See the Python docs (2) and the Mozilla docs (3) as examples. The pattern on those sites is even a little nicer by showing an icon on hover.

This has been on my backlog for awhile, i.e. to have the hovering
"anchor holders". I'll try to move it up on the list.

Thanks,

Jonathan

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Niels Bom 2022-10-21 16:49:44 Re: Usability ideas: text width and headers that are links
Previous Message Niels Bom 2022-10-21 13:54:07 Usability ideas: text width and headers that are links