instructlab / docs.instructlab.ai

The docs.instructlab.ai public documentation repository. PRs accepted and encouraged!
https://docs.instructlab.ai/
8 stars 8 forks source link

Navigation bar may be confusing to new users #1

Open cedricclyburn opened 2 months ago

cedricclyburn commented 2 months ago

Navigation bar may be confusing to new users

The current navigation bar on our MkDocs site defaults to showing a subdirectory rather than the homepage. This can be disorienting for new users who expect to land on the main page when first visiting the site.

Problem:

image
cedricclyburn commented 2 months ago
Screenshot 2024-08-30 at 12 50 38 PM

Full screen view is easier to understand the navigation however

jjasghar commented 2 months ago

I also debated doing the "top bar", but after the "tree" of information, the side nav bar seemed most reasonable. The challenge is that you have to have it "large" and not the "mobile" size to see everything.

We'll have to figure out if there's a way to change the default top layer, but i haven't found it off hand yet.

cedricclyburn commented 2 months ago

Ah I understand, yeah I'll also take a look at the top layer, but another option could be to combine the Welcome & About page into one singular index page?

jjasghar commented 2 months ago

Totally, I was hoping to add more to the Welcome section, but I don't know of anything off hand. Do you have any ideas there? Maybe the license? I don't know; I'm open to suggestions.

Actually the "main" license should be in references right?

cedricclyburn commented 2 months ago

Perhaps once ready, that’ll be a great place for not only the installation guide but getting started guide as well (yours and the one I’m hoping to contribute from my team). Personally I like how it currently is, I think reflecting the main README of the organization is best for consistency :)

cedricclyburn commented 2 months ago

yes references or resources, something of that sort