New documentation theme

[capjamesg]

Description

This PR adds a new documentation theme to the supervision docs.

Type of change

• Docs change

How has this change been tested, please provide a testcase or example of how you tested the change?

This change can be tested by running mkdocs serve and clicking through the docs site.

Any specific deployment considerations

N/A

Docs

N/A

[SkalskiP]

Hi @capjamesg 👋🏻 I have a few comments. I didn’t leave inline suggestions because it’s a bit difficult for me to pinpoint exactly where they should go in your proposed code. For that reason, I’m sharing my feedback here instead.

• The layout of the new docs isn’t consistent with docs.roboflow.com. Below, I’ve included screenshots from docs.roboflow.com, the old supervision.roboflow.com, and the new supervision.roboflow.com for reference. Please pay special attention to where the empty spaces are located. In the new supervision.roboflow.com, these spaces appear between the central section and the side panels, whereas in both docs.roboflow.com and the old supervision.roboflow.com, they were placed outside the main content area. Additionally, the central section in the new docs doesn’t seem to be properly centered.

• Could we rename the “Products” dropdown in the top navbar to “Docs”? Then, I would move the Universe link under the “Resources” tab instead. Additionally, I think it should be possible to navigate from the Supervision docs directly to the Roboflow docs, for example.

• Could we make the behavior of the dropdown menus in the open-source docs more closely match how dropdowns work in the Roboflow docs? In particular, I mean the hover effects. Please make the dropdown item’s background gray when the mouse hovers over it. Also, the dropdown should open when the mouse hovers over the corresponding navbar item.

• The dropdown panel that appears when typing in the search bar is narrower than the search bar itself, which causes a visual bug (as shown in the screenshot below).

• The top navbar hides when you scroll down. In the product docs, however, it remains visible at all times. This behavior is most likely controlled by the MkDocs configuration.

• In the new supervision.roboflow.com, the background hover color in the top navbar is not consistent with the color used in docs.roboflow.com.

• As a result of your proposed changes, the part of the navbar that links to the open-source repository and displays the number of stars and forks has disappeared. I believe this is a crucial component for supporting the growth of the open source community, so we absolutely need to restore it.

• The cookbook cards have become distorted.

• In the new supervision.roboflow.com, the background hover color in the side navbars is not consistent with the one used in docs.roboflow.com.

[SkalskiP]

Hi @capjamesg 👋🏻 Thanks a lot for all the updates! I’ve reviewed the revised docs theme and noticed a few things that could still be improved:

• The Resources Docs dropdown closes when it should remain open. This happens in two scenarios:

  • When you hover over the button to open the dropdown, move the cursor onto the dropdown, and then back to the button.

  • When you hover over the button to open the dropdown, then move the cursor to a neighboring dropdown button.

supervision-docs-bug-1.mp4

supervision-docs-bug-2.mp4

• The layout of elements on the cookbooks card is still different from the original docs. In particular, the interaction between the supervision version and the specific label is broken. See old vs. new:

• When the list of elements in the right navbar is long enough to require scrolling, the items scroll under the "Table of contents" heading and remain visible underneath.

supervision-docs-bug-3.mp4

• When using the search bar, the suggestions are cut off so you can't see the text that should appear on the right. Part of the text in the suggestions is simply unreadable. Old vs. new: