Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigation bar may be confusing to new users #1

Open
cedricclyburn opened this issue Aug 30, 2024 · 6 comments
Open

Navigation bar may be confusing to new users #1

cedricclyburn opened this issue Aug 30, 2024 · 6 comments

Comments

@cedricclyburn
Copy link

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:

  • Users need to navigate backwards to reach the homepage
  • Default landing page is a subdirectory instead of the main page, perhaps the Welcome page can be an index and host the "About InstructLab"
  • Potentially confusing user experience, especially for first-time visitors
image
@cedricclyburn
Copy link
Author

Screenshot 2024-08-30 at 12 50 38 PM

Full screen view is easier to understand the navigation however

@jjasghar
Copy link
Member

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
Copy link
Author

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
Copy link
Member

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
Copy link
Author

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
Copy link
Author

yes references or resources, something of that sort

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants