README has links to non-force-directed beeswarms

Open
#194 0 comments 0 reactions 0 assignees View on GitHub

@curran is already working on this.

Since Aug 18, 2021.

  • #200 by @curran — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Read the README and compare both beeswarm links with the Observable plot they reference. Decide whether the links need clearer labeling or replacement, taking into account the concern that force-directed positioning can move points from their correct positions. Done means the README no longer misleads readers about the plot; an open linked pull request indicates this work may already be underway.

Written by the indexing model from the issue text.

Description

The README has two links to a beeswarm plot on Observable: one in the text and one an image. The current version of the plot on Observable is not force directed, so perhaps it might be confusing for people who want to learn how to create a force-directed beeswarm?

I love the d3-force library but I have mixed feelings about using it for beeswarm plots because the points can be moved slightly away from their correct positions. So I'm not sure about the best way to update the README (or perhaps it's fine the way it is!)

Dominant language
JavaScript
Stars
2k
Forks
395
Avg merge
5h 46m
Merged PRs (30d)
1

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from d3/d3-force

All issues in d3/d3-force

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.