Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure README #221

Merged
merged 5 commits into from
Oct 6, 2023
Merged

Restructure README #221

merged 5 commits into from
Oct 6, 2023

Conversation

Fil
Copy link
Member

@Fil Fil commented Aug 8, 2023

This proposal (see page):

  • Uses h2 and an icon everywhere, for a nice (automated) TOC on GitHub
  • Duplicates the 1-line description at the top
  • Defers to d3js.org for the API reference (now called Documentation)
  • Adds Documentation and Examples links
  • Moves Observable to the top of the Installing section

For this particular module, the reference to beeswarm is obsolete. (Though I still like the old beeswarm, and am tempted to make a notebook for it 🤓).

Once we settle on a template, this will have to be replicated to all the modules covered by d3js.org

@Fil Fil requested a review from mbostock August 8, 2023 15:43
@Fil
Copy link
Member Author

Fil commented Oct 5, 2023

hmm, maybe we don't need the icons anymore…

Copy link
Member

@mbostock mbostock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the D3 logo at the top of the README (like we do on d3/d3) and then use a complete sentence to introduce the library. You can copy the first paragraph from https://d3js.org/d3-force.

@Fil
Copy link
Member Author

Fil commented Oct 5, 2023

OK, I've minimized it again (preview). Also, using the D3 logo from d3/d3 — would it be any better to have a local copy?

Copy link
Member

@mbostock mbostock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you could keep the emoji in the bulleted list to be a little more “fun”. I like the conciseness of the list here.

@Fil
Copy link
Member Author

Fil commented Oct 6, 2023

I tried emojis, and while I found them useful to identify sections in the long readme, I don't like them in the simple list (in particular, the emojis for "help" and "examples" are not evocative enough).

with emoji

@mbostock
Copy link
Member

mbostock commented Oct 6, 2023

I like the emojis just to make it a little less dry. We can add them later.

@mbostock mbostock merged commit c3e73cf into main Oct 6, 2023
1 check passed
@mbostock mbostock deleted the fil/readme branch October 6, 2023 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants