tauri-apps / tauri-apps/tauri-docs

Simplify sidebar submenus and avoid hidden submenus

Open
#2,762 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
1.1k
Forks
887
Avg merge
2d 8h
Merged PRs (30d)
48

Description

Our current sidebar has overly nested guides and I think it may be harder to discover theses guides and navigate between them. I think the more nested structures could just be simple headers instead of another submenus, so

link
submenu 
  |_ link
    |_ submenu
      |_ link

would be

link
submenu 
  |_ link
  |_ submenu (as small header) (non-clickable) (always expanded)
  |_ link

or just flatten out

Contributor guide

Open the contributing guide

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

No file or test is named in the issue. Start by locating the sidebar configuration and submenu rendering in the documentation source, then compare the current nested navigation with the proposed flattened structure; done means deeper submenu labels are non-clickable, always expanded headers or the navigation is flattened.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.