[mkdocs] - duplicate anchor links used on page
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 28
Description
When nested property names are the same as property names at the top level of a trace, they use the same anchor, but should use different ones.
E.g. in our current docs
https://plotly.com/javascript/reference/scatter/#scatter-error_x-visible
https://plotly.com/javascript/reference/scatter/#scatter-visible
For mkdocs site,
/javascript/reference/scatter/#scatter-error_x-visible won't work
and
/javascript/reference/scatter/#scatter-visible
will take you to the first one on the page, which is actually the error-x-visible property
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
Reproduce the duplicate anchors in the MkDocs-rendered scatter reference using the two URLs shown in the issue, then trace how nested and top-level property anchors are generated. Done means both links resolve to their corresponding properties without one taking the place of the other.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100