Have Docs/Reference sidebars reference each other #23
Conversation
| }, | ||
| { | ||
| type: "doc", | ||
| id: "docs/introduction/how-does-pants-work", |
There was a problem hiding this comment.
This doesn't need to be solved now, but just exploring the space: what happens if we want to change this entry page?
For instance, we add some awesome new landing page for Pants 2.34, that doesn't exist in 2.33 or earlier.
Is it possible to customise per version? Or use some generic entry point like docs that each version redirects itself?
There was a problem hiding this comment.
Yes, there is per-version sidebars (this particular file is for docs/, note all the other files in this PR (one per version)
There was a problem hiding this comment.
Oh, From the file names, I assumed they were auto-generated from this one... are they all manually maintained? When we add a new version do we have to manually copy it across?
There was a problem hiding this comment.
Nope, it's handled automatically by the versioning scripts. Check out the Docusaurus versioning docs
There was a problem hiding this comment.
Ah, I see https://docusaurus.io/docs/versioning#tagging-a-new-version
Once it's tagged, I assume they're then manually maintained? As in, you made these edits "manually" (by copying the file around, I imagine)?
…d/pantsbuild.org into jcannon/docs-ref-links
Fixes #8 by adding "cross-links" from/to Docs/Reference at the bottom of their respective sidebars.