Design

We use Tachyons for most CSS needs. I'm still planning to write an ADR on that — in the meantime refer to Tachyon's creator @mrmrs' blog post Scalable CSS.

Ideas for improvements

• General

  • Think about some UI to switch between versions and view other supplemental information, docs.rs solves this nicely with a dropdown:

    

  • Also we might want some space for anything not related to the current project but cljdoc itself

  • Two top bars might help but would take a lot of screen space.

• API browsing
  • Codox' nested sidebars are nice because:
    • They allow you to see namespace and var-list at the same time
    • They have this neat scrolling indicator
  • Currently we are not rendering protocol member methods
  • improve overall visual hierarchy of def-block
• Article view

  • Some documents might be long, similar to the Codox scroll-indicator we could have a little UI at the top that indicates what section you're in

    

  • With some JS users might even be able to click on it and navigate sections in a document

  • The sections would need to be inferred from the rendered HTML

  • There is little styling done for rendered Markdown or Asciidoc. We could style things using plain CSS or adding tachyons classes to elements.

  • Syntax highlighting is not implemented yet

• Since we build on hiccup we could try to write code in a way that allows us to reuse components on multiple platforms