nav: updates #3599
nav: updates #3599
Conversation
jorgeorpinel
commented
May 28, 2022
•
jorgeorpinel
commented
- Standard and optimized sidebar.json structure
- Fix some problems and typos related to the changes
- Split into actionable PRs per section + assign to corresponding teams
- Apply similar changes to MLEM.ai/doc
- Remove some of oldest redirects too?
content/docs/sidebar.json
Outdated
| "slug": "ml-experiment-tracking", | ||
| "label": "ML Experiment Tracking" | ||
| }, | ||
| "experiment-tracking", | ||
| "model-registry", | ||
| "data-registry" | ||
| { | ||
| "slug": "ml-model-registry", | ||
| "label": "ML Model Registry" |
There was a problem hiding this comment.
Hi @rogermparent qq: where do we add words for default capitalization from sidebar slugs? I'd like to make ml->"ML" to reduce these structures. Thanks
p.s. also "ML Frameworks" in the DVCLive docs
There was a problem hiding this comment.
Currently the code is written in a way that only dvc can be uppercased. But if we want to be able uppercase more than just DVC, it should be doable with a little code refactoring! I'll open a issue for it. (#3601)
There was a problem hiding this comment.
#3602 has been merged and ml should become ML automatically :)
There was a problem hiding this comment.
Awesome, thanks Julie! Should this be a feature of the docs engine in general? CML and MLEM for example could use this 🙂
There was a problem hiding this comment.
Yes! Already opened a pr for adding this feature to our doc engine theme (See gatsby-theme-iterative#22)
There was a problem hiding this comment.
dvclive - > "DVCLive" ? Or is that too much
There was a problem hiding this comment.
a bit too much, Jorge (how many places do we have)?
There was a problem hiding this comment.
A few, same as the other ones. But yes never mind, it complicates the logic.
Gatsby Cloud Build Reportdvc.org 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 2m PerformanceLighthouse report
|
content/docs/sidebar.json
Outdated
| { | ||
| "label": "CML", | ||
| "slug": "cml", | ||
| "source": "cml/index.md", | ||
| "label": "CML", | ||
| "icon": "cml", | ||
| "children": [ |
There was a problem hiding this comment.
cml -> "CML" would also be good to auto-capitalize. Plus how is this external link implemented now? The nav still has a substructure for CML (that is currently ignored). Seems like it's hard-coded somewhere? We can remove that 🙂 cc @rogermparent (lmk where and I will, thanks).
p.s. also "API" (used in DVCLive docs)
There was a problem hiding this comment.
If I'm understanding correctly, we have a line in redirects.json that converts the /doc/cml to https://cml.dev/doc.
| "label": "CML", | ||
| "slug": "cml", |
There was a problem hiding this comment.
Links with type: "external" actually need a label but no slug :)
{
"label": "CML",
"icon": "cml",
"url": "https://cml.dev/doc",
"type": "external"
},
And since our code only uppercases certain words when we are converting slugs to labels, the label needs to be uppercase on its own.
There was a problem hiding this comment.
Good to know, thanks (fixed in a74facb).
We should def. document the doc engine features and usage at some point 😬 rel. iterative/gatsby-theme-iterative#17
|
Anyway, this was a clean-up / proof of concept / test. Way to huge... I need to split it later (not a priority). Thanks though! |
