✨ Iterate on next docs
#2250
✨ Iterate on next docs
#2250
Conversation
| @@ -1,5 +1,7 @@ | |||
| # See docs at: https://mystmd.org/guide/frontmatter | |||
| version: 1 | |||
| extends: | |||
| - https://raw.githubusercontent.com/jupyter-book/meta/refs/heads/main/myst.yml | |||
There was a problem hiding this comment.
This broke the docs/ link at the top because the landing page doesn't have access to the sidebar of the TOC. If we want docs/ to point to next.jupyterbook.org then we should define a different way for users to access the TOC of the documentation.
It also made me realize that when that sidebar is gone, then all the navbar items are gone too on mobile, because the hamburgur menu is gone with no sidebr, even though the navbar items are also in the same hamburger menu...
There was a problem hiding this comment.
I've made the /docs link an absolute URL to next.jupyterbook.org. Am I misunderstanding you -- do you want docs to point to move away from the landing page onto some content?
I don't love the present view, but you can navigate away from the landing page via the inline links or bottom buttons. My feeling is that we might want to make it possible to have a hide-able sidebar even at full screen, so that the user sees a collapsed burger menu by default? That would facilitate landing pages without forcing us to use narrow views, or drop the sidebar.
It also made me realize that when that sidebar is gone, then all the navbar items are gone too on mobile, because the hamburgur menu is gone with no sidebr, even though the navbar items are also in the same hamburger menu..
Yes, this is a problem with losing the sidebar. I think I suggested restoring it (for now) somewhere, but I've since had the thought about the theme above.
There was a problem hiding this comment.
I think it'll confuse people if they hit a landing page (jupyterbook.org), then click on "docs" at the top, and are just redirected to the same page. The landing page is going to feel like a different website from the "docs", which is why I'd made docs/ point to the first page of the docs, rather than the landing page.
So the way I thought about it, next.jupyterbook.org is the future landing page for Jupyter Book, not the first page of the docs.
That said, I suggest you play around with different UX here and I'm happy to provide feedback on what feels intuitive.
There was a problem hiding this comment.
Oh, that's interesting! I like that distinction. I will try setting next.jupyterbook.org (and therefore the logo link URL) dropping into the landing page, and docs/ jumping to e.g. the quick-start, as you originally changed it to be.
| @@ -0,0 +1,102 @@ | |||
| import { u } from "unist-builder"; | |||
There was a problem hiding this comment.
this is copied from the myst docs, right? can you put a comment at the top that notes where it was copied from? Is there no way to just re-use the mystmd plugin? We have to copy/paste?
There was a problem hiding this comment.
Unfortunately we can't re-use for now; the upstream plugin assumes that xrefs are local. I think this falls under the "fix in future" category; longer-term I'd like to establish a pattern for publishing bundled plugins that can be loaded from a URL.
There was a problem hiding this comment.
Is there an issue tracking this that we can track? Then you could just add a comment like "Copied from XXX because we can't yet load external plugins, see for more detail"
There was a problem hiding this comment.
Certainly; jupyter-book/mystmd#1101. I'll modify the source!
myst.ymlmyst:plugin to xref into MyST directives/roles list