yearn / yearn/yearn-devdocs

fix strange sidebar linking behavior

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

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
90
Forks
92
Avg merge
1h 6m
Merged PRs (30d)
2

Description

Issue:

Link elements in sidebars that link to other docs in the same sidebar seem to often be treated as the primary sidebar element, even when clicking on the doc that is linked to. For example, a link from the V3 yVault developer section to the smart contract section will send the user to that section page and focus the sidebar on the right spot. But if you click on the page that is linked separately, the sidebar will often jump to the developer section and focus on the link element.

Can't figure out why or how to stop this. Maybe can use multiple sidebars: https://docusaurus.io/docs/sidebar/multiple-sidebars as a work-around.

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

Reproduce the sidebar behavior described for the V3 yVault developer and smart contract sections, then review the Docusaurus multiple-sidebars guidance linked in the issue. Done means navigating to either page keeps the sidebar focused on the page actually being viewed rather than on the cross-linked entry.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.