tpmccallum
commented
1 year ago This is a good point. Here is a bit of background as to why this is currently the case; I thought I might number the points so we can reference individually whilst trying to find a new idea or solution to the "keep area ToC" request.
- At present we can only have one
.hbstemplate per.mdfile. - The
.hbstemplate, referenced in each.mdfile's frontmatter, is what renders the left-hand-side menu. - An
.mdfile such as the CLI Reference is useful for both Spin and Cloud projects (there are also other.mdfiles that are useful to two or more projects i.e. the contributing to the docs.mdis the same for Spin, Cloud and Bartholomew projects). - Rather than mirror
.mdfiles, that are common across two or more projects, we have opted for keeping just a single version of a particular common file in a common area (this area has its own.hbstemplate). - A user will see the common left-hand-side menu when visiting a specific common
.mdfile because that.mdfile has the common.hbsreferenced in its frontmatter. - We could update the site to open common documents in a new tab but that essentially still takes the user to a new place (and might not be a better solution that, as you say, just hitting the back button).
- It might be possible to update Bartholomew itself to use dynamic templates (as apposed to typing hard-coded templates into each
.mdfrontmatter section).
I was tootling around looking at stuff in the Spin docs and clicked on the CLI reference. Now the Spin TOC has disappeared and there's links about contributing to Bartholomew whoever he is.
The back button gets me home, so this is definitely not a big deal! But (a) it's a bit odd that the TOC changes and (b) it means I can't keep the reference open while scanning the TOC for relevant links. It would be nice to have the shared content but retain the area TOC.