plotly / plotly/plotly.js

[mkdocs] resolve links in several 'Quick Reference' pages

Open
#7,613 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
JavaScript
Stars
18.3k
Forks
2k
Avg merge
2d 12h
Merged PRs (30d)
28

Description

Links are not correctly pointing to the relevant pages. For example, in Function Reference, 'data array' is meant to jump to a section titled 'retrieving-data-layout', but that section does not exist.

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

Start by reviewing the several “Quick Reference” pages, especially Function Reference, and compare each link target with the section headings it is intended to reach. Check the “data array” link against the expected “retrieving-data-layout” section and verify that all affected links resolve to existing relevant pages or anchors.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.