From: | "Niels Bom" <niels(at)nielsbom(dot)com> |
---|---|
To: | pgsql-docs(at)lists(dot)postgresql(dot)org |
Subject: | Usability ideas: text width and headers that are links |
Date: | 2022-10-21 13:54:07 |
Message-ID: | e6f470fa-030e-41cc-9326-010b8081f75e@app.fastmail.com |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | 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 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#description
4: https://github.com/nielsbom/tampermonkey_scripts/blob/main/scripts/postgresql.org.js
From | Date | Subject | |
---|---|---|---|
Next Message | Jonathan S. Katz | 2022-10-21 15:42:08 | Re: Usability ideas: text width and headers that are links |
Previous Message | Daniele Varrazzo | 2022-10-21 09:50:07 | Re: Restriction on comments |