Skip to content

Make docs home page friendlier #3096

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

Closed
ianhi opened this issue Feb 7, 2021 · 1 comment · Fixed by #3104
Closed

Make docs home page friendlier #3096

ianhi opened this issue Feb 7, 2021 · 1 comment · Fixed by #3104
Assignees
Labels

Comments

@ianhi
Copy link
Contributor

ianhi commented Feb 7, 2021

Problem

Currently the landing page of the docs is not super inviting. https://ipywidgets.readthedocs.io/en/latest/index.html#
image

  1. There is no explanatory or welcome text
  2. The TOC in the sidebar is totally collapsed:
    image

Proposed Solution

  1. Add some friendly opening text.
    • e.g. "Ipywidgets is a library that ...." - "If you want to learn ___ go to <link>, if you want to ___ go to <link 2>"
  2. Add a gif of some awesome widget interactions
    • and/or add some active widgets to the

Additional Context:

Two widget libraries that could serve as inspiration:
https://ipycytoscape.readthedocs.io/en/latest/
https://ipycanvas.readthedocs.io/en/latest/

@willingc
Copy link
Contributor

willingc commented Feb 8, 2021

PR #3104 is a first pass at this task using the suggested projects as inspiration. Thanks @ianhi.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants