Nitrokey / Nitrokey/nitrokey-documentation

Handle multiple identical target articles in navigation

Open
#434 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
36
Forks
53
Avg merge
1d 16h
Merged PRs (30d)
5

Description

Currently if two links in the navigation point to the same article, only one of them will be highlighted.

Possible solutions:

  • highlight all links matching the target (doctree hacks?)
  • use in-article links instead for these cases (instead of a navigation item on the left)
  • also open for better solutions

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

Reproduce the issue with two navigation links pointing to the same article, then inspect the documentation navigation behavior and how the target article is selected. The issue lists highlighting all matching links and using in-article links as possible directions, but no solution or completion criteria has been chosen yet.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.