platformsh-docs icon indicating copy to clipboard operation
platformsh-docs copied to clipboard

:lipstick: Improvements to the website design

Open trolologuy opened this issue 3 years ago • 5 comments

We've noticed the following small issues with the current design that we'd like to address at some point:

  • Anchors
    • Clicking anchors could copy the URL to the clipboard
  • Spacing in lists
    • Spacing between paragraphs is too large so they seem unconnected
  • Inline code
    • Links doesn't show as different from code not in links
  • Code blocks
    • A button to copy
      • Maybe leave out ellipses
      • Consider leaving out comments, but could keep
  • Images could be zoomable
  • Pages with technologies or stacks could have the logo.
  • Highlight text and have a button displayed to send a form to forward typos, unclarities, ... maybe only for logged-in users (to be able to get back to them).
  • When specific sections are Enterprise or Elite only, have a shiny highlighting of that section to clearly separate it from the rest of the document's flow./docs/reference/syntax/variables#assign-step)
  • Unify white space in between elements
  • Decide on inactive scrollbars next to table of contents

trolologuy avatar Feb 21 '22 14:02 trolologuy

I wouldn't display the date of the last change. I don't think automated changes add much value and often is misleading (when I move a page I might have to update a page with a link to it and so that page would be shown as updated even when its content hasn't been verified or anything). And we have too few people working on it to make changes frequently enough that it would make sense manually.

CollierCZ avatar Feb 22 '22 15:02 CollierCZ

  • Clicking on a first-level menu should open the overview page ...
  • Clearly highlight if an element in the navbar has subelements ...

These are going to be resolved in upcoming changes to the information architecture. We already have some potential designs for it.

I'd add that the ToC overlaps with content at certain widths.

CollierCZ avatar Mar 24 '22 10:03 CollierCZ

I went through the list and reorganized a bit (removing some items already done).

Also this bit is already possible:

When a user is on the bottom of a section page that has other children, these could be listed at the bottom of the page.

You just need to change the layout in the frontmatter. Either remove it so it goes back to the default or set it to list.

CollierCZ avatar May 23 '22 08:05 CollierCZ

Allow nesting of templates when they are related. For example for Drupal, that would give:

trolologuy avatar Oct 28 '22 15:10 trolologuy

Removed some of the items done in #2768 and added the notes from #2785

CollierCZ avatar Jan 10 '23 10:01 CollierCZ