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

Simplify API web design #776

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Simplify API web design #776

wants to merge 10 commits into from

Conversation

dustinvtran
Copy link
Member

@dustinvtran dustinvtran commented Oct 2, 2017

Having a top navigation bar, API sidebar, and tutorials is unnecessary. The biggest change is that I removed all docs on the navigation bar and either made it explicitly part of the API docs (as docstrings) or threw it into the tutorials section.

screen shot 2017-10-01 at 9 49 42 pm

todo

  • change the sidebar and allow more fine-grained pages via a dynamic scrollbar with collapsible sections
  • deliberate on how to organize tutorials given API tutorials. should it be "Tutorials" and "API tutorials"? "Tutorials" and "Advanced tutorials"? Maybe shove all API tutorials into api/ sidebar like TensorFlow docs sometimes does?

@dustinvtran dustinvtran changed the title Reorganize API web design Simplify API web design Oct 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant