Can we have an API reference?

[multimeric]

As well as the general readme, I think reflux should have an API.md file that would list the properties of the definition objects that you pass into createStore, createAction etc. as well as their methods.

At the moment, even Store#getInitialState isn't even mentioned in the readme, which is very confusing. I would be happy to make a PR, but I'm sure someone with a better knowledge of the codebase would make a better API reference.

[srph]

Good point 👍.

Also, is there anyone that thinks Reflux needs an improved documentation ✨? Besides splitting the README documentation to smaller files, maybe use RTD? imo, a long documentation page with different subjects isn't appropriate to read and edit 👎.

[tmbtech]

@TMiguelT if you want to start the API.md, I'll be happy to contribute.

[spoike]

Yes, please. I'm currently limited with other obligations, so any help with getting API documentation through md files up would be helpful.

[srph]

Anybody want to setup a gh-pages for a doc site?

[spoike]

Sorry for not replying. We've moved the projects to the reflux org, and extracted the core methods to it's own project. We'll be working with setting this up with a main site as well as gh-pages. Probably using hexo.io as static site builder, to bundle in with jsdoc or esdoc.

[devinivy]

The reflux-core project has an API reference here. We'll be trying to improve the presentation and usability of the docs by creating a site some time in the future. We'll also take PRs to improve the existing docs. We'd love help, so check out #447 :)