riptano / docs-ui

The UI and theme for DataStax Docs.
https://riptano.github.io/docs-ui/
Mozilla Public License 2.0
2 stars 0 forks source link

Rethink the location of page metadata elements #82

Open eric-schneider opened 6 months ago

eric-schneider commented 6 months ago

Original Basecamp task: https://3.basecamp.com/5214332/buckets/27604022/card_tables/cards/6687556414 Original reporter: @djsauble

The :page-colab-link:, :page-time-commitment:, :page-skill-level:, and # steps UI components contain useful information, but they're using a lot of valuable real estate right now. There's a ~100px high strip of screen under the title that's occupied by this information right now. Let's find a more efficient way to display it.

Some ideas:

eric-schneider commented 6 months ago

We should avoid putting anything in-line with the page title, principally because it will negatively affect the legibility of the title (distracting). In addition, page titles can technically span multiple lines, which will likely become a rabbit hole design-wise.

I think we should try reducing the side of these elements and play with the spacing first. This will likely give us the most flexibility across screen sizes, and will more easily afford additional elements should we add them in the future. You can't rely on the presence of the right-nav because the right-nav is not present on smaller screen sizes. I guess if you put them in the right column, you could just collapse them to where they currently are on small screens. But it's a lot to consider. Pinecone attempted to do something across the right column, and they are clearly running into these very same issues: https://docs.pinecone.io/docs/openai