search

senecajs / seneca-entity

Entity plugin for seneca
MIT License
13 stars 15 forks source link

Cannot find complete documentation #42

Closed dikarel closed 5 years ago

dikarel commented 7 years ago

When it comes to looking for docs/references, user experience is frustrating:

  1. Google "seneca entity"
  2. Go to result 1 at https://github.com/senecajs/seneca-entity
  3. Look for anything resembling API docs, only to discover it's not in there
  4. Go back to Google
  5. Go to result 3 at http://senecajs.org/docs/tutorials/understanding-data-entities.html
  6. I have to read through an essay of a tutorial
  7. I now have some high-level ideas on how to use seneca-entity, but some details are still missing (e.g. What other options/parameters are there? Are there other functions that may also be useful? How to perform more complex operations?)

If complete documentation webpage is immediately accessible, it would significantly improve ease of use. If such a page already exists, I was unable to find it via Googling.

As reference, I can easily find and browse bluebird.js's API at http://bluebirdjs.com/docs/api-reference.html