📖 Initial User Facing Documentation #164
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Merged
rowanc1
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a repeat of #136. @stevejpurves I didn't merge, having trouble with github, sorry.
Purpose: to create an initial set of docs for jupyterlab myst
The story so far:
🌱 seeding the docs, adding a note on figures, images and cell attachments
I've started this a little adhoc by adding a section that I specifically came across while using the extension. It would be great to get this PR into shape as an initial set of docs for ahead of JCON23, so there is an easy way for people to get oriented.
Possible TOC is:
Landing page
Installation
Getting Started
Learning MyST
Guides
Writing a software tutorial with MyST
Writing a scientific paper in a Notebook
Features (Notebook Specific)
Frontmatter
Images and figures
Bibliography
Would love input on how to take this further in the short term, ideas for structuring the content and what content to include. A big question is how much content to specifically provide here, potentially duplicating to some degree) versus pointing back to the main docs on myst-tools? also where we do point back it would be good to have a consistent pattern