Usability ideas: text width and headers that are links - Mailing list pgsql-docs

From Niels Bom
Subject Usability ideas: text width and headers that are links
Date
Msg-id e6f470fa-030e-41cc-9326-010b8081f75e@app.fastmail.com
Whole thread Raw
Responses Re: Usability ideas: text width and headers that are links  ("Jonathan S. Katz" <jkatz@postgresql.org>)
List pgsql-docs
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.

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

I've created a user script (4) to do this in my browser. You can test it with the Tampermonkey browser extension.

I'd <3 to hear your thoughts.

Cheers,
Niels

1: https://www.postgresql.org/docs/15/index.html
2: https://docs.python.org/3/library/stdtypes.html#dictionary-view-objects
3: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce#description
4: https://github.com/nielsbom/tampermonkey_scripts/blob/main/scripts/postgresql.org.js



pgsql-docs by date:

Previous
From: Daniele Varrazzo
Date:
Subject: Re: Restriction on comments
Next
From: "Jonathan S. Katz"
Date:
Subject: Re: Usability ideas: text width and headers that are links