MyST-NB icon indicating copy to clipboard operation
MyST-NB copied to clipboard

Proposed documentation re-structure

Open choldgraf opened this issue 4 years ago • 1 comments

Background

I think that the MyST Notebook documentation could be more impactful if we re-structured it slightly, with the goal of cleanly separating out different functionality. (this is similar to the myst restructure proposal, although I think these docs don't need as much re-structuring).

A proposal

What if we did the following:

  • Tutorials
    • Create your own MyST Markdown Notebook from scratch, convert to ipynb with Jupytext, convert it back. Include some basics of cell / notebook metadata etc
    • Get started with MyST Notebooks with Sphinx
  • Topic Guides
    • MyST Notebooks specification
    • Writing MyST Notebooks
      • For Jupyter Book
      • With Jupytext
    • MyST Notebooks with Sphinx
      • (in general, split up our current Sphinx docs into a structure that follows the diataxis framework)
    • Parse MyST Notebooks with Python
  • About MyST Notebooks
    • Contributing
    • Changelog

choldgraf avatar May 23 '21 17:05 choldgraf

The proposed layout makes sense to me if we think with the diataxis mindset.

damianavila avatar May 31 '21 19:05 damianavila