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

Overhaul documentation #3568

Merged
merged 23 commits into from
Jun 9, 2022
Merged

Overhaul documentation #3568

merged 23 commits into from
Jun 9, 2022

Conversation

philippjfr
Copy link
Member

@philippjfr philippjfr commented May 29, 2022

  • Redesign of homepage
  • Redesign of Getting Started guide
  • Leverage myst-parser Markdown more heavily
  • Use sphinx-design for more modern look

Test build now available at: https://pyviz-dev.github.io/panel/

@philippjfr
Copy link
Member Author

philippjfr commented May 29, 2022

Copying comment from @MarcSkovMadsen in #3573:

  1. Add autoreload

image

  1. Include the Panel Jupyter Preview icon in the Tip

image

(New users will not know which icon you are talking about)

  1. Remove "construct construct"

image

@philippjfr philippjfr added status: WIP type: docs Related to the Panel documentation and examples labels May 29, 2022
@MarcSkovMadsen
Copy link
Collaborator

One things I would like to see are

Beautiful is better than ugly.

The Penguins k-means example of the front page and the colors should be beautified

image

Simple is better than complex + There should be one-- and preferably only one --obvious way to do it.

Please focus on one api (probably pn.bind or pn.depends).

@MarcSkovMadsen
Copy link
Collaborator

MarcSkovMadsen commented Jun 6, 2022

Regarding ugly. The default HoloViews colors could be improved a lot. Especially the light blue for tooltips is soo badly looking and hard to read.

image

(and in this example there is also a lot of unused space. Why is it not just stretching to the available window size?)

@philippjfr
Copy link
Member Author

Hmm can you check what's up with the fonts in that example. Should be using Ubuntu font but I guess it's not available on windows.

@MarcSkovMadsen
Copy link
Collaborator

Exactly. Ubuntu is not available on windows.

@jbednar
Copy link
Member

jbednar commented Jun 6, 2022

Please focus on one api (probably pn.bind or pn.depends).

Definitely pn.bind, not pn.depends. PRs welcome to update any example using pn.depends to use pn.bind. Volunteers also welcome to propose a new default Bokeh theme. Now's a good time to do that, with Bokeh 3.0 coming up.

@philippjfr philippjfr force-pushed the doc_enhance branch 4 times, most recently from e93b89b to a270869 Compare June 8, 2022 16:25
@MarcSkovMadsen
Copy link
Collaborator

Does HoloViz, anaconda or anyone around Bokeh have access to a designer. It would mean so much for Bokeh and HoloViz if Bokeh could get an attractive, modern Styling.

@jbednar
Copy link
Member

jbednar commented Jun 9, 2022

Donation of design services would be greatly appreciated!

@maximlt
Copy link
Member

maximlt commented Jun 9, 2022

Yes I'd love some help from a designer, and I'd be happy to see Orsted as a logo on Panel's site 🙃

@philippjfr
Copy link
Member Author

Merging this as a first cut. Many follow up PRs to come.

@philippjfr philippjfr merged commit 44d220c into master Jun 9, 2022
@philippjfr philippjfr deleted the doc_enhance branch June 9, 2022 17:38
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

Successfully merging this pull request may close these issues.

None yet

4 participants