Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Initial User Facing Documentation #164

Merged
merged 8 commits into from
Jul 29, 2024
Merged

📖 Initial User Facing Documentation #164

merged 8 commits into from
Jul 29, 2024

Conversation

rowanc1
Copy link
Member

@rowanc1 rowanc1 commented Jun 29, 2023

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

@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch executablebooks/jupyterlab-myst/docs/init

@rowanc1 rowanc1 mentioned this pull request Jun 29, 2023
@rowanc1 rowanc1 changed the title Initial User Facing Documentation 📖 Initial User Facing Documentation Jun 29, 2023
@rowanc1 rowanc1 added the documentation Improvements or additions to documentation label Jun 29, 2023
@agoose77
Copy link
Collaborator

This is a start, and I don't want to block whilst figuring out strategy! Going to merge.

@agoose77 agoose77 merged commit 9f0ab73 into main Jul 29, 2024
4 of 7 checks passed
@agoose77 agoose77 deleted the docs/init branch July 29, 2024 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants