Visx: [docs] document api of all packages

[hshoff]

[Flaque]

Hey, this might be a stupid question, but where's the repo for the docs?

[hshoff]

Great question. My current plan is to add docs to each packages/**/Readme.md then write a script that builds those to a new dir called docs/ at the vx repo root. Open to suggestions for alternative solutions!

[Flaque]

I looked into react-docgen a bit for linking docs to code. But react-docgen assumes a class structure for it's objects and doesn't really work all that well with the existing code. It might be a future thing, but I'm just gonna write docs in the Readme's for the moment.

[Flaque]

Is brush "stable"-ish right now? There's no longer a gallery version of it. Should I just hold off on writing the docs on it for now?

[trainorpj]

Do you need help writing some of the documentation? I could submit a PR for the boxplots docs, if nobody has that action.

I've been watching this project for a while, and I like it a lot. I'm interested in helping out, if you'll have me!

[Flaque]

Do it! :D

Let me know it you need any help ❤️

[williaster]

🙈 didn't mean to close the entire issue

[kandros]

These are the packages with missing documentation

• [ ] brush
• [ ] clip-path
• [ ] brush
• [ ] drag
• [ ] event
• [ ] hierarchy
• [ ] responsive
• [ ] tooltip
• [ ] zoom

[trainorpj]

I wrote the docs for the boxplot component, and I'm happy to contribute to other utilities/components

(I was a bit swamped before, but I have some time now)

[trainorpj]

I just hacked together a little site we can use to keep track of progress on the docs:

https://trainorpj.github.io/vx-docs-progress/

I figured there are so many packages/components it'd be nice to keep track of things at a high level.

Link to the repo. Feel free to make changes. I used d3 but didn't use vx... 😬

[hshoff]

Very helpful, thank you @trainorpj! I'm hoping for all green by v1

[hshoff]

This should be fixed in: https://github.com/hshoff/vx/pull/399

Need to add descriptions, but at least api doc generation is automated now.