search

holoviz / panel

Panel: The powerful data exploration & web app framework for Python
https://panel.holoviz.org
BSD 3-Clause "New" or "Revised" License
4.64k stars 504 forks source link

Cheat Sheet doesn't feel like a Cheat Sheet #5116

Open ahuang11 opened 1 year ago

ahuang11 commented 1 year ago

I was wondering whether we should rework https://panel.holoviz.org/api/cheatsheet.html because it doesn't feel like a cheat sheet, but it's a good overview though and could be renamed Overview / Summary of API.

I think ideally, we should have a separate Cheat Sheet page, not nested under API Reference, and the word count should be reduced by 90%--instead there should be much more visuals and reference links instead.

For inspiration: https://matplotlib.org/cheatsheets/_images/cheatsheets-1.png https://pandas.pydata.org/Pandas_Cheat_Sheet.pdf https://docs.xarray.dev/en/stable/howdoi.html https://s3.amazonaws.com/assets.datacamp.com/blog_assets/Python_SciPy_Cheat_Sheet_Linear_Algebra.pdf

maximlt commented 1 year ago

I think this page was created out of a previous user guide that felt somewhat more like a cheat sheet.

I think ideally, we should have a separate Cheat Sheet page

The docs overhaul was inspired from the Diataxis framework that I think doesn't state where to locate cheat sheets in the four main categories which are Tutorials/HowTo/Explanation/Reference. So that cheat sheet was put in the API reference category, not great but not terrible either.

droumis commented 1 year ago

I personally still think that cheatsheets are mainly useful for quick starts (and restarts) as expressed here: https://github.com/holoviz/holoviews/issues/2395#issuecomment-1436017068