uabrc / uabrc/uabrc.github.io

ENH: Update Navigation Bar Organization

Open
#491 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev: enhancement 🛠️✨
Dominant language
Python
Stars
24
Forks
15
Avg merge
10d 3h
Merged PRs (30d)
1

Description

What would you like to see added?

As of now, the navigation bar seems cluttered where all of the documentation for Cheaha, Cloud, etc is grouped with Account Management, Help, etc. It would be helpful to break these out into actual sections using the navigation.sections theme feature in MkDocs. I'm including a before image as well as a mockup of an after image below for comparison

Before:

Before Without Sections

After:

Mockup with Sections

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the MkDocs configuration and reviewing the current navigation setup. Enable the mentioned navigation.sections theme feature, then build or preview the documentation and confirm that Cheaha and Cloud content are separated from Account Management and Help as shown in the mockup.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.