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

Suggestions for improving the website #1369

Closed
11 tasks
maximlt opened this issue May 26, 2020 · 6 comments
Closed
11 tasks

Suggestions for improving the website #1369

maximlt opened this issue May 26, 2020 · 6 comments
Labels
type: docs Related to the Panel documentation and examples

Comments

@maximlt
Copy link
Member

maximlt commented May 26, 2020

Hi,

I've spent quite a lot of time on the website and I wanted to suggest some potential improvements:

  • Change the color of the text in the search bar. It's green right now and is difficult to read.
    image
  • Move the search bar to a place where it's easier to find and make it bigger
    image
  • Replace static images by GIFs on the index page to demonstrate the power of Panel and the kind of interactivity you can get (applies to the readme too)
    image
  • Headers and sub-headers should be permalink for easier referencing to specific content in a page
    image
  • Headers and sub-headers should appear in a table of content always available to the user to more easily browse through the content of a page
  • There should be a link to a binder environment on every notebook page
  • The Reference Gallery should be above the Gallery in the table of content (I use it a lot more)
  • The Reference Gallery should have a table of content at the top to quickly find a widget/layout/pane (it's pretty hard now, specially for the widgets, I usually search through the page)
  • The first line describing a widget/layout/pane in the reference gallery should be highlighted in its own box. It's the most important piece of information of the page.
    image
  • The API reference manual isn't very useful as of now, clicking on a subpackage removes completely the API table of content which is then difficult to explore
    image
  • It doesn't look very good when set to a small size (same as on mobile if I'm not mistaken)
    image

These are just suggestions that I believe would make the website look better and easier to use. Feel free to make some more suggestions that I would then add to this list.

@maximlt maximlt added TRIAGE Default label for untriaged issues type: docs Related to the Panel documentation and examples and removed TRIAGE Default label for untriaged issues labels May 26, 2020
@maximlt
Copy link
Member Author

maximlt commented May 26, 2020

As for the first item, I believe the font color in the search bar is set in the sphing_holoviz_theme. It could just be set to black.
https://github.com/pyviz-dev/sphinx_holoviz_theme/blob/b822647c6770d7c4d8231efb193edf2988342c82/sphinx_holoviz_theme/static/css/main.css_t#L2136

@maximlt
Copy link
Member Author

maximlt commented May 29, 2020

The Dask documentation (the examples exactly) has a binder environment and each page suggests to run the associated notebook in JupyterLab, it works pretty well.
image

See that repo for more info: https://github.com/dask/dask-examples

@philippjfr
Copy link
Member

I'd like to switch to the new theme used by Bokeh, which was designed with mobile viewing in mind. Adding a binder link to each page would also be nice.

@MarcSkovMadsen
Copy link
Collaborator

MarcSkovMadsen commented May 29, 2020

Will you keep the green color @philippjfr on the app bar and as the Panel color?

I actually like the green color. But maybe I would like it to be the very nice material green color #4CAF50. :-)

@maximlt
Copy link
Member Author

maximlt commented May 29, 2020

Switching to the Bokeh theme would resolve many of my initial suggestions :)

@philippjfr
Copy link
Member

Some of these suggestions definitely still apply but a lot has also already changed and the remainder is being tracked elsewhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Related to the Panel documentation and examples
Projects
None yet
Development

No branches or pull requests

3 participants