[mkdocs] some examples don't run in the docs
Open
Nobody has claimed this yet.
bug
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 28
Description
If you take an example like this from the current docs, it doesn't run in the mkdocs site
https://plotly.com/javascript/tile-map-layers/#openstreetmap-tiles
This example uses d3 but the mkdocs site isn't loading that.
We should:
- determine what other JS libraries are needed by the docs and ensure the are loaded
and/or - rewrite examples to make sure no additional JS libraries are needed
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 OpenStreetMap tiles example in the linked JavaScript documentation and inspect how the MkDocs site loads its scripts. Identify the other documentation examples that depend on external JavaScript libraries, then ensure those libraries are loaded or the examples no longer require them; done means the affected examples run on the MkDocs site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- d3, javascript
- Domain
- documentation, web-dev
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100