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

Improve documentation #1

Open
4 tasks
andypike opened this issue Feb 16, 2016 · 0 comments
Open
4 tasks

Improve documentation #1

andypike opened this issue Feb 16, 2016 · 0 comments

Comments

@andypike
Copy link
Owner

andypike commented Feb 16, 2016

There is a lot of documentation in the readme and I think it covers most things but think about improving the documentation:

  • Add a wiki page for each component (Forms, Commands, Queries and Presenters)
  • Trim down the readme to be more concise and link off to the wiki where required
  • Add documentation to methods and publish API docs
  • Add examples for popular use cases

Take a look at https://readthedocs.org/

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