canjs / can-query-logic

Perform data queries and compare queries against each other. Provides logic useful for data caching and real-time behavior.

Home Page:https://canjs.com/doc/can-query-logic.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Review docs skeleton

justinbmeyer opened this issue · comments

Steps:

  1. checkout 5-0 branch of canjs: https://github.com/canjs/canjs/tree/5-0
  2. npm install && ./node_modules/.bin/bit-docs
  3. Launch local fileserver
  4. Open: http://localhost:8080/canjs/doc/can-query-logic.html

You should see:

canjs_-_can-query-logic

Please review that page for understandability, clarity, correctness. Do these APIs make sense? Are they explained well?

NOTE A: There's going to be a "Using queryLogic instances" section. I'm focused on the different configuration options right now.

NOTE B: The methods are not documented yet. That will happen later.