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

Planning: Short-term plan for Jupyter Book 2.0 documentation vs. mystmd.org/guide #2239

Open
1 of 3 tasks
choldgraf opened this issue Oct 30, 2024 · 7 comments · May be fixed by jupyter-book/mystmd#1732
Open
1 of 3 tasks
Labels
documentation Something related to the documentation

Comments

@choldgraf
Copy link
Collaborator

choldgraf commented Oct 30, 2024

Currently, a lot of content is now duplicated between jupyterbook.org and mystmd.org. At the same time, some content at jupyterbook.org is now outdated because it's been updated for the MyST engine.

Historically, this was an ongoing challenge with Jupyter Book and Sphinx. We have a lot of duplicated content between the Sphinx extension page and the Jupyter Book docs for that extension.

We should define a short term breakdown of documentation between Jupyter Book and MyST to avoid this problem.

Where are the new docs

next.jupyterbook.org has the latest docs.

Suggestion for how to break this down

  • Use jupyterbook.org to describe what is possible, and focus on end-to-end documentation for specific workflows and outcomes (e.g. tutorials). It gives a high-level overview of the project, MyST, and provide pointers to relevant places. It should link to mystmd for anything more detailed like how-tos and reference.
  • Use mystmd.org/guide to have the extra detail of how to write myst, multiple options for configuration, theming etc. Assume that MyST acts as the "how-tos and reference guide" of Jupyter Book.

Longer term

In the long term, this might be confusing to readers because content will exist in two different places (I'm particularly worried about asking users to go to a different website to discover new instructions for how to use a tool). We'll need to decide whether this breakdown makes sense and I'd love to hear thoughts on that from @rowanc1 .

That said, I think our goal here should be "set up a short-term documentation structure that makes it safe to release the JB 2 alpha without confusing people".

To do

  • Agree on a general breakdown (general idea we agreed on is here)
  • Document guidelines for this breakdown in mystmd.org/guide:
  • Create a stub page that cross-references this in the jupyter book docs (in a thin Jupyter Book contributor guide).
@choldgraf choldgraf added the documentation Something related to the documentation label Oct 30, 2024
@choldgraf choldgraf moved this to Needed for alpha in Jupyter Book MVP Oct 30, 2024
@rowanc1
Copy link
Member

rowanc1 commented Nov 13, 2024

I think this can now be closed - @choldgraf any objections?

From @agoose77 and my conversation on discord:

We discussed the challenge of knowing what should go into the Jupyter Book docs -- we all share the same concerns about getting the split right.

I've been reflecting on this in the last week, and speaking with you and @rowanc1 has helped clarify things for me.

JB should be tutorial focused (upper diataxis quadrants) over time, MyST-MD moves towards the lower diataxis quadrants extensions/plugins will, over time, be preferentially defined in the "mystmd ecosystem", and enabled as feature-flags in e.g. JB. This means that we can build a coherent spec in one place, and crucially write distribution-like documentation (e.g. JB which ships sphinx proof) that points to the MyST-MD documentation without referring to features that don't exist in MyST-MD land. We will move to a policy of bidirectional cross-links between JB and MyST-MD

At a high level, my vision is that JB the user-facing tool, and mystmd is the power-user tool. This will evolve over time.

Image

@choldgraf
Copy link
Collaborator Author

I suggest we document the decision somewhere that we can refer back to in the future, then consider this closed. Do you have an intuition for where? Maybe we create some kind of tracking issue for docs improvements in general w JB2, and this language is part of guidelines there?

@agoose77
Copy link
Collaborator

@choldgraf i think we can probably define this in either MyST's docs, or Jupyter Book, and then embed the figure in both projects.

@rowanc1
Copy link
Member

rowanc1 commented Nov 13, 2024

In meeting: put this in the mystmd docs! (we also talked about putting this in the team-compass, want the information close to the source so that it can be referenced).

@rowanc1 rowanc1 changed the title Short-term plan for Jupyter Book 2.0 documentation vs. mystmd.org/guide Planning: Short-term plan for Jupyter Book 2.0 documentation vs. mystmd.org/guide Nov 13, 2024
@rowanc1
Copy link
Member

rowanc1 commented Jan 6, 2025

As a slight clarification: I think that the mystmd docs should not remove existing tutorials/guides, just that the focus of documentation additions should shift over time towards more detailed guides/explanations/reference materials. Additionally, that shift is only after JBv2 is fully live and discoverable.

mystmd will continue to be stand alone tool, and needs to continue to have stand alone documentation, albeit lighter on the tutorials for books, which we do a better job of in the jupyter-book tool.

@choldgraf
Copy link
Collaborator Author

That's helpful to understand your thinking @rowanc1 , thanks (I am basing most of my understanding of y'alls thinking based on this comment)

It sounds the short-term plan is still clear: add more how-tos and tutorials to the Jupyter Book docs, and don't add complete reference+explanation material to Jupyter Book and instead use MySTMD for that.

The long-term plan is less clear to me: is Jupyter Book just a subset of the MyST docs? If we add a feature to MySTMD that is relevant to a multi-page site, then would we need to make the same docs addition to both MySTMD and Jupyter Book?

For now, we can just focus on porting over relevant MySTMD docs and not changing anything on the MyST docs side.

If helpful I'm happy to take a meeting to discuss this, but since we have some clarity in the short-term, I'm also happy to just focus on making some docs improvements to Jupyter Book and then seeing how we all feel about this once V2.0 is out

@rowanc1
Copy link
Member

rowanc1 commented Jan 6, 2025

Yeah, I am also not totally sure how things will shake out long term, I think that is ok though. Things will probably get clearer as the tools each get more definition. I think we should take another assessment when JBv2 is out, and until then we should just focus on good tutorials/guides in the JB docs (which is already happening..!).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something related to the documentation
Projects
Status: Post Alpha Release Comms
Development

Successfully merging a pull request may close this issue.

3 participants