Scala documentation, web sites: What should be improved?

Scaladoc issues,

  1. Too much empty space, both in sidebars and central content.
  2. Companions objects on different lines than corresponding classes/traits. Difficult to quickly understand which classes and traits do have companion objects. Find them polluting the hierarchy and taking up the space. Don’t feel confident if it’s a companion object at all or not, should read the name properly to understand it. Is it even considered a companion object if it’s, e.g. in a different source file?
  3. I can’t scroll the whole page to access all information, but have to focus on different parts of the page and scroll there.
  4. Big and visible search bar, easy to click, is now hidden behind a tiny icon in the upper right corner.
  5. Old version shows me the root cats package documentation immediately, on the new one, I need to click it first, which may not be obvious for everyone.
  6. Old version reflects the opened element in the browser’s address bar. In the new I need to right-click on an element and then “copy link”.

I’m not a professional UX person, just noticed an inner resistance to use Scala 3’s Scaladoc comparing to the old one, and tried to analyze where the resistance is coming from.

2 Likes