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

Consolidate d3.chart docs #1

Open
samselikoff opened this issue Dec 8, 2013 · 0 comments
Open

Consolidate d3.chart docs #1

samselikoff opened this issue Dec 8, 2013 · 0 comments

Comments

@samselikoff
Copy link

Hi there!

I know you all have been working a lot on d3.chart's code and API, so I thought I could help out with the docs. I wanted to solicit your input on how I could be most useful.

One thing that's caused me (and others) to stumble a bit while learning d3.chart is where to go when I have a question. There's some info on the site, some pages in the github wiki, and some blog posts. Some of the examples across those three sources are out of date - for example, certain charts don't use the "events" object for defining lifecycle events. It's also hard to find explanations for some of the API decisions, like why we append elements in the insert method rather than the enter lifecycle events, as D3 devs are used to doing.

I imagine many other developers have visited the site and been a bit confused about where to go. Lots of the nav items link to blank pages or links to the github wiki. The wiki also has many articles that are blank. I think the question for newbies is, where should I start?

d3.chart is very promising and I'd love to see the docs and guides come together. Would it be helpful if I started touching up the docs? Do you have any roadmap or plans on where to consolidate the info - github wiki vs. misoproject website? I'd love to hear any feedback.

Thanks again for all your work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant