Skip to content

Proposed documentation re-structure #329

Open
@choldgraf

Description

@choldgraf

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions