From: Niels Bom <niels@nielsbom.com>
To: pgsql-docs@lists.postgresql.org
Subject: Usability ideas: text width and headers that are links
Date: Fri, 21 Oct 2022 15:54:07 +0200
Message-ID: <e6f470fa-030e-41cc-9326-010b8081f75e@app.fastmail.com> (raw)
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 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.
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#descri...
4: https://github.com/nielsbom/tampermonkey_scripts/blob/main/scripts/postgresql.org.js
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: niels@nielsbom.com, pgsql-docs@lists.postgresql.org
Subject: Re: Usability ideas: text width and headers that are links
In-Reply-To: <e6f470fa-030e-41cc-9326-010b8081f75e@app.fastmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox