A lot of stutter in our left navigation

[dprotaso]

I was wondering if we should aim to clean up our navigation a little bit. I notice there is quite a bit of 'stutter' among the sections and subsections

Secondly, some navigation items appear to be 'nodes' that only group together a bunch of subtopics. This leads to excessive clicks to find content.

I don't know what the right solution is - but am looking for ideas.

[dprotaso]

cc @iRaindrop @evankanderson for input

[evankanderson]

Yes! I think we may need to write and/or refactor content to improve the navigation to allow us to reduce this stutter.

[dprotaso]

I also see that material mkdocs supports having bolded headers - some of them can be pages like 'Tutorials' and 'Changelog'. 'Getting Started' doesn't have a link.

[dprotaso]

Though - I guess you lose the indentation

[lakxy]

Hi @evankanderson @dprotaso

Is this issue still open for contribution ?
there is a linked PR but it is dated earlier than the issue.

[evankanderson]

Hi,

This is still open for contribution. The referenced PR was being asked to avoid introducing more stutter, rather than cleaning up existing instances in the navigation.

[evankanderson]

(you can use /assign to assign an issue to yourself)

[lakxy]

/assign

[lakxy]

Hey @evankanderson
Are there any specific reference that I can follow in my implementation?
Any design pattern that should be followed...as other CNCF projects.
Once I have clarity over the design pattern I can move ahead to resolving this nav issue.

Thank you.

[lakxy]

Hi @dprotaso @evankanderson
I need confirmation, Is the expected outcome supposed to align with patterns/practices in the material/mkdocs mentioned.

Please clarify and I will fix it!
Thank you.

[evankanderson]

I'm not sure that Dave or I have thought deeply about how to solve this problem -- Material for Mkdocs (and the nav plug-in we use) have a number of tools and modes for specifying the navigation tree. The main problem is using those tools consistently in our documentation.

At a minimum, Dave is pointing out that we have a number of places where the navigation looks like:

Installing Knative   >
   Installing Knative With YAML
   Installing Knative With Operator

Where "Installing Knative" is repeated in each sub-topic, making it hard on smaller devices to even see the distinguishing details.

[lakxy]

@evankanderson
Would it be okay to truncate the common substring from parent to child...in the nav display?

I might be wrong, but it seems a simpler fix...

[lakxy]

Would it be okay to truncate the common substring from parent to child...in the nav display?

If not this, then I guess it would require significant edits, for relevant naming....