[BUG] Documentation URL anchor - result hidden by header
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
When linking to a specific function in the docs using an anchor (http://foo.bar/something#function), the first few lines incl. the most important part of a function - its signature, will be hidden by the header.
Setup
- Win10, Firefox 77.0
Steps to Reproduce the behavior
- Click on this link
Expected behavior
- The documentation of
module.saltutilis being shown, the scroll position is at the beginning of the functionsaltutil.find_cached_joband it isn't partially hidden by the sticky page header
Screenshots
Versions Report
N/A
Additional context
It looks like it could be fixed by applying scroll-padding-top: 70px (value is based on min-height: 50px and margin-bottom: 20px of .navbar) to the corresponding element, but I fail to find the right one by applying it "live" using my browser's dev tools...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Salt documentation page and inspect the sticky .navbar and the saltutil.find_cached_job anchor target using browser dev tools. Trace the documentation styling that controls anchor scrolling, then verify that opening the link leaves the function signature visible below the header in Firefox.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- css
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100