You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current documentation uses a lot of custom components (Admonition, Details, Notice, Tabs, and so on). In most cases, these components reduce readability and impair comprehension more than they assist the reader. It's a pervasive problem in the documentation. We could also use some refinement in our design (font sizes for different heading levels, a less aggressive presentation for inline code and (especially!) code blocks.
We’ll kick off this effort by reviewing and revising topics that need to be updated for other reasons. For example, Windows desktop supports local users for Community and Team editions in v14, so as part of updating the body for those enhancements, we'll minimize the disruptive components.
The content you are editing has changed. Please copy your edits and refresh the page.
As a possible part of this project, we can add guidance in the docs UI reference for when to use Admonitions, Tabs components, Notices, etc. This comment is a good starting point.
lsgunn-teleport
changed the title
Reduce the use of distracting UI elements in the documentation
[Tracking] Reduce the use of distracting UI elements in the documentation
Sep 8, 2023
The current documentation uses a lot of custom components (Admonition, Details, Notice, Tabs, and so on). In most cases, these components reduce readability and impair comprehension more than they assist the reader. It's a pervasive problem in the documentation. We could also use some refinement in our design (font sizes for different heading levels, a less aggressive presentation for inline code and (especially!) code blocks.
See also
gravitational/docs#93
gravitational/docs#362
We’ll kick off this effort by reviewing and revising topics that need to be updated for other reasons. For example, Windows desktop supports local users for Community and Team editions in v14, so as part of updating the body for those enhancements, we'll minimize the disruptive components.
Tasks
The text was updated successfully, but these errors were encountered: