-
Notifications
You must be signed in to change notification settings - Fork 14
Open
Labels
Description
What happened
- Jupyter Book 2 is about to be released as the "default" install for Jupyter Book
- Chris spent a few days refactoring the documentation and doing his best to smooth over confusion and answer questions for people who upgrade.
- This re-worked the structure of the documentation and provided more high-level guidance to help people navigate the project.
- This included revitalizing the feature voting table and having pointers to help navigate the broader community
Why is it valuable
- Documentation is a critical part of making projects attractive and accessible - they are what turn technological codebases into products others want to use
- Docs are also a key way to reduce maintainer effort by helping users answer questions without needing a direct response
- This effort also laid a stronger foundation in documentation structure that should make it easier to build on top of it in the future.
- Hopefully it makes the community more likely to attract new contributors and turn them into helpful team members
Links to learn more
- PR that implemented this: Reorganize docs to follow topic folder structure and prep content for JB2 jupyter-book/jupyter-book#2422
- principles behind the refactor: https://github.com/jupyter-book/jupyter-book/blob/next/docs/contribute/docs.md
Acknowledgements
- Project Pythia and CryoCloud and the Berkeley educational project are our primary member communities using MyST and JB2 so their support is what covers the cost of these kinds of Foundational contributions