Showing content from https://github.com/jupyterlab/jupyterlab/issues/15099 below:
JupyterLab documentation wishlist · Issue #15099 · jupyterlab/jupyterlab · GitHub
I wanted to highlight a few areas that I think can be improved in our docs easily with simple CSS/config/restructuring:
- "Develop Extensions" page starts with a scary banner "Your extensions may break with new releases of JupyterLab" (see screenshot below). I am not convinced that this information is the first thing that a potential extension developer wants to read. It is important, yes but I would put it slightly lower with "Overview of Extensions".
- In dark mode the visited link colours are hard to read/inaccessible with contrast ratio 1.7 (we do not need AAA, but AA would really help)
- The dark mode is forced upon us, based on preferred system colour; there is no toggle to change it (we should enable the toggle, or if there is none, switch to a theme which has one)
- There is a poor discoverability of certain topics highly relevant to extension development:
- There is no link to JupyterLab API Reference in the sidebar on "Develop Extensions" page, it is only on the "Contribute" page. I think this should be included in both
- similarly: CSS Patterns, Design Patterns, Internationalization and Localization are all relevant to extension development but are only shown on "Contribute" page. An extension developer may miss these important topics.
- I wonder if Using JupyterLab components should be moved from "Contribute" to "Develop Extensions". It does not really fit with either, but it seems more about building upon JupyterLab than contributing.
- The searchbar cold get some love to avoid overlap
- Do we need "Privacy policies" in the header? Could it be a part of "Get Stated"?
Any objections/alternative suggestions to any of the points?
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4