Bug 7888 - Documentation titles often get wrapped
Summary: Documentation titles often get wrapped
Status: NEW
Alias: None
Product: ThinLinc
Classification: Unclassified
Component: Documentation (show other bugs)
Version: trunk
Hardware: PC Unknown
: P2 Normal
Target Milestone: LowPrio
Assignee: Bugzilla mail exporter
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-04-11 12:43 CEST by Pierre Ossman
Modified: 2024-10-03 10:06 CEST (History)
1 user (show)

See Also:
Acceptance Criteria:


Attachments

Description Pierre Ossman cendio 2022-04-11 12:43:32 CEST
The titles we use in the ThinLinc Administrator's Guide are generally very long and descriptive. This might have worked well before, but the space is much more limited now that we've switched to Sphinx (bug 4951).

This results in a layout that is sometimes very difficult to read. Titles get wrapped both on the pages themselves, but also in the side bar that is supposed to give a clean overview.

We need to either look at a different layout, or severely limit the maximum length of our titles.

If we change the titles we also need to consider references to them. URLs generally uses some short form already, but we do have references that just mention which title to look for.
Comment 1 William Sjöblom cendio 2024-10-03 10:03:28 CEST
One thing to remember here is that these titles also make up a big part of our search engine previews. Hence, cutting out context from page titles that's made obvious based on its position in the ToC often will negatively impact the search engine previews.

This would be slightly relieved by closing 8318.
Comment 2 William Sjöblom cendio 2024-10-03 10:06:28 CEST
There are also cool things like this that would relieve the search engine preview issues highlighted above.

https://developers.google.com/search/docs/appearance/structured-data/breadcrumb

Note You need to log in before you can comment on or make changes to this bug.