Docs design

[demenech]

As part of our revamp process, we'd like to improve our docs design.

❓ Question:

What would be a good design for docs?

[demenech]

I personally really like the style of documentation of https://mui.com/material-ui/getting-started/overview/ and https://tailwindcss.com/docs/installation. Notes I made about it:

• Docs
  • Left side menu
    • Seems like a convention between component libraries
    • Makes it very handy to find information about different components, I usually just CTRL+F what I'm looking for on the docs when I'm using UI libs and the link on the left side menu get highlighted
    • Components list is always visible
    • e.g:
      • https://tailwindcss.com/docs/width
      • https://mui.com/material-ui/react-autocomplete/
  • Structure could be:
    • Documentation
      • What is Portal.JS?
      • Getting started
      • Contribute
    • Components
      • UI
        • Nav
        • Footer
        • ...
      • Dataset
        • ...
      • Search
        • ...
      • ...
  • The root page for components page could be like what Angular Material has: https://material.angular.io/components/categories