Skip to content
This repository has been archived by the owner on Sep 7, 2020. It is now read-only.

Documentation #6

Closed
Olical opened this issue Sep 20, 2015 · 3 comments
Closed

Documentation #6

Olical opened this issue Sep 20, 2015 · 3 comments
Assignees

Comments

@Olical
Copy link
Owner

Olical commented Sep 20, 2015

I need to document the full extent of the API with examples. More importantly, I need to document adding features that are missing.

@Olical Olical self-assigned this Sep 20, 2015
@Olical
Copy link
Owner Author

Olical commented Oct 11, 2015

Anyone have any opinions or wishes around this? Should I use GitHub wiki? Just have a DOCUMENTATION.md / put it in README.md? Keeping it in a file is my preference. What do you want documented, API / usage examples?

It'd probably end up similar to my other project, thoughts on that? https://github.com/Olical/EventEmitter

@wuxianliang
Copy link

EventEmitter's documents are good! Probably, we will use react-faux-dom for reusing D3 codes. So one concept proof example with some hints on which parts can not work just by drop in is good enough for me.

@Olical
Copy link
Owner Author

Olical commented Oct 22, 2015

I'm going to integrate with inch-ci http://inch-ci.org/github/Olical/react-faux-dom?pending_build=113610 for API documentation but will also add examples to a README / wiki.

@Olical Olical mentioned this issue Nov 5, 2015
@Olical Olical closed this as completed in #26 Nov 7, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants