Improving Documentation/Tutorials with a New Jupyter Working Group

Jupyter needs better documentation, and we need your help to make it happen! A new Jupyter Documentation Working Group is being formed to make documentation better across all of Jupyter, and not all of the work is writing docs, so if you’re interested in any of these focus areas or early tasks, please stop by the Github issue (link here) and leave a comment that expresses “I’m interested!”:

Possible major focuses:

  • Content (writing docs)
  • Discovery/community engagement (getting users info they need)
  • Feedback (what needs to be documented? what info do people need?)

Potential early work targets:

  • Characterize documentation needs across subprojects (what needs to be added, improved, made consistent across each)
  • Capture/store (possibly automate) readthedocs traffic stats/CSVs for last 90 days on a regular basis to get rough metrics on what’s important to users
  • Add some easy CI tests to ensure commands in the tutorial run without erroring (would have helped prevent the docs from breaking this time as mentioned above), other CI tests
  • “Get Help” effort spanning multiple subprojects, to consistently communicate to users how they can get help from Jupyter stakeholders/developers/resources, on each subproject’s documentation site
  • Document insights from recent issues/bugs (such as the Homebrew bug)
  • And more!

Read more about the new Documentation Working Group here, we’d love to have your perspectives and expertise as we get this new working group started. Thanks to everyone who can join in!


I don’t know if you are seeking ideas or only spreading the word, but I think that maybe implementing a footer like on could be a good first step to gather some data on docs needs:

Maybe this could be a sphinx theme used across projects? FYI there was now most projects switched to pydata theme.

1 Like