Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Tracking] Reduce the use of distracting UI elements in the documentation #371

Open
7 of 10 tasks
lsgunn-teleport opened this issue Aug 11, 2023 · 1 comment
Open
7 of 10 tasks
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@lsgunn-teleport
Copy link
Contributor

lsgunn-teleport commented Aug 11, 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
#93
#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

  1. documentation size/md
  2. backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm
    lsgunn-teleport
  3. backport/branch/v14 documentation size/sm
    lsgunn-teleport
  4. backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/sm
  5. backport/branch/v13 backport/branch/v14 documentation size/sm
  6. backport/branch/v12 backport/branch/v13 backport/branch/v14 documentation size/md
    lsgunn-teleport
@lsgunn-teleport lsgunn-teleport added the documentation Improvements or additions to documentation label Aug 11, 2023
@lsgunn-teleport lsgunn-teleport self-assigned this Aug 11, 2023
@ptgott
Copy link
Contributor

ptgott commented Aug 22, 2023

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 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants