Skip to content
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

Closed
brimoor opened this issue Jun 2, 2020 · 4 comments
Closed

Layout and style the FiftyOne docs #145

brimoor opened this issue Jun 2, 2020 · 4 comments
Assignees
Labels
backlog Issues related to the roadmap and feature backlog design Work related to the design of a feature/UI element

Comments

@brimoor
Copy link
Contributor

brimoor commented Jun 2, 2020

Here's a v1 design for our docs from our designer:

Personally, I like the colors/styling of the light theme the best:

83524744-08621100-a4b2-11ea-83ca-a0fc9f434515

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:
83524827-262f7600-a4b2-11ea-8a8f-860aba6e2d8e

and here's a tutorial from TF:
83524855-32b3ce80-a4b2-11ea-8fbc-49e205aa402b

Distilling all of this, here are the page elements that I like:

  • Top bar allows for selection between Get Started, Docs, Tutorials, GitHub, etc
  • When viewing a page (tutorial or API docs), left navbar shows a top-level-only list of other tutorials/modules that one can click on. The detailed table of contents for the current page appears on the right side bar
  • Search bar in upper right, with GitHub link to the right of it
  • Tutorials have View source on GitHub and Download notebook links

Discussion is welcome!

@brimoor brimoor added the backlog Issues related to the roadmap and feature backlog label Jun 2, 2020
@brimoor brimoor added the design Work related to the design of a feature/UI element label Jun 2, 2020
@voxel51 voxel51 deleted a comment from tylerganter Jun 15, 2020
@voxel51 voxel51 deleted a comment from tylerganter Jun 15, 2020
@voxel51 voxel51 deleted a comment from tylerganter Jun 15, 2020
@voxel51 voxel51 deleted a comment from tylerganter Jun 15, 2020
@lethosor
Copy link
Contributor

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
Should be possible to adapt for our purposes

@brimoor
Copy link
Contributor Author

brimoor commented Jun 22, 2020

@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

@brimoor
Copy link
Contributor Author

brimoor commented Jun 22, 2020

@lethosor also, one important thing is to include the header and footer from the main website when rendering all of the doc pages.

@brimoor
Copy link
Contributor Author

brimoor commented Jul 2, 2020

Resolved by #228 and #236!

@brimoor brimoor closed this as completed Jul 2, 2020
kaixi-wang pushed a commit that referenced this issue May 11, 2023
Ensure static dir in teams app
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog Issues related to the roadmap and feature backlog design Work related to the design of a feature/UI element
Projects
None yet
Development

No branches or pull requests

2 participants