-
Notifications
You must be signed in to change notification settings - Fork 557
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Layout and style the FiftyOne docs #145
Comments
PyTorch's right sidebar nav is implemented by a custom theme: https://github.com/pytorch/pytorch_sphinx_theme/blob/master/pytorch_sphinx_theme/layout.html |
@lethosor I think it's fine to get started based on the PyTorch theme (with our colors). Feel free to look for others if you'd like. One of the less ideal things about the PyTorch RHS bar is that it doesn't automatically update to reflect the current section that you're reading. TF's does, for example. Also, I personally find the orange bar on the TF one helpful to draw attention to the presence of the table of contents over there. But, these are relatively minor things- the big goal is to avoid subsections of a page from appearing on the left, which is very cluttered. A question we have is whether we want our top-level sections (user guide, tutorials, etc) to appear as choices across the top bar, or if the LHS table of contents is simple enough that all of that content can be listed over there. Like https://prodi.gy/docs, for example. Open for discussion |
@lethosor also, one important thing is to include the header and footer from the main website when rendering all of the doc pages. |
Here's a v1 design for our docs from our designer:
Personally, I like the colors/styling of the light theme the best:
The more important point is making sure the various components of the docs are laid out in a user-friendly way.
For reference, here's a tutorial from PyTorch:
and here's a tutorial from TF:
Distilling all of this, here are the page elements that I like:
Get Started
,Docs
,Tutorials
,GitHub
, etcView source on GitHub
andDownload notebook
linksDiscussion is welcome!
The text was updated successfully, but these errors were encountered: