plotly / plotly/plotly.js

[mkdocs] - Page and section headings are not corrrect

Open
#7,628 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

Currently page headings and example headings have text like "line-and-scatter-plot":

Image

But these should be like our existing headings, eg: "Line and Scatter Plot"

Image

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 locating the MkDocs page and example-heading sources that produce the hyphenated text, then compare them with existing headings such as “Line and Scatter Plot.” Done means the affected pages render readable title-style headings instead of strings like “line-and-scatter-plot”; no specific files or tests are named.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.