matomo-org / matomo-org/developer-documentation

Make submenu on a page more visible

Open
#456 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
PHP
Stars
58
Forks
88
Avg merge
6d 3h
Merged PRs (30d)
13

Description

![image](https://user-images.githubusercontent.com/273120/111541563-88552f80-87d5-11eb-815a-3173184a47bd.png)

it's currently shown in the left menu underneath the regular menu but it's barely visible there.

It be great to have it more visible so it's more clear what content is on a page and jump to the content you need more quickly.

One way could be like this

![image](https://user-images.githubusercontent.com/273120/111541673-a589fe00-87d5-11eb-988d-90eb15d2f6fd.png)

another way could be to have a tag like `{toc}` and put this into most guides so we could place the table of content inline where we want to show it as part of the guide. Like below the title and the initial paragraph etc. On some guides where there are like hundreds of submenu items we could not show it.

![image](https://user-images.githubusercontent.com/273120/111542194-47114f80-87d6-11eb-8ed6-e228fcb173ee.png)

(it would be styled differently)

There might be sometimes a lot of items (potentially > 100).

Any thoughts?

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

Review the current left-menu submenu and the guide pages shown in the issue screenshots. Compare the proposed more-visible submenu with the inline `{toc}` alternative, including pages with potentially more than 100 items; done means one agreed presentation is defined for guide navigation.

Written by the indexing model from the issue text.

Assessment

Domain
design, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.