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

doc #3

Open
criloz opened this issue Apr 23, 2017 · 0 comments
Open

doc #3

criloz opened this issue Apr 23, 2017 · 0 comments

Comments

@criloz
Copy link
Member

criloz commented Apr 23, 2017

@Ignusmart each time that we end a feature you will need to document them, you should create high level documentation where explain with great detail, how to use the api, the concepts, and make examples using tools like runkit or codepen, please make high quality examples that respond the answers of new if is possible create diagrams, that allow to the people to understand easily, you will need to take your time making them, please see documentation of popular libraries like react, mobx, etc.

#oid [omniid]
#resource map
#offline api

  • explain the basics of offline query queries, the omni3id paths, add runkit examples
  • explain the high-level api for make queries and add run kit examples
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