-
Notifications
You must be signed in to change notification settings - Fork 671
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
Comments
I think this can now be closed - @choldgraf any objections? From @agoose77 and my conversation on discord:
|
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? |
@choldgraf i think we can probably define this in either MyST's docs, or Jupyter Book, and then embed the figure in both projects. |
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). |
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.
|
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 |
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..!). |
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
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
The text was updated successfully, but these errors were encountered: