Permalink
Browse files

adds can-stream, but not to test

  • Loading branch information...
1 parent 4f3323d commit ea3a48018dc2f78af2b38c93ecde6a3253553e47 @justinbmeyer justinbmeyer committed Oct 25, 2016
Showing with 78 additions and 14 deletions.
  1. +4 −4 build.js
  2. +7 −3 docs/can-guides/Guides.md
  3. +64 −5 docs/can-guides/commitment/api-guide.md
  4. +0 −1 docs/can-guides/experiment/pmo/tutorial.md
  5. +3 −1 package.json
View
@@ -23,13 +23,13 @@ stealTools.export({
},
// ignore jquery
ignore: [function(name){
- if(name.indexOf("jquery") === 0) {
+ if(name.indexOf("jquery") === 0 || name.indexOf("kefir") === 0) {
return true;
} else {
return false;
}
}],
- exports: {"jquery": "jQuery", "can-util/namespace": "can"},
+ exports: {"jquery": "jQuery", "can-util/namespace": "can", "kefir": "Kefir"},
removeDevelopmentCode: false
},
"core": {
@@ -42,13 +42,13 @@ stealTools.export({
},
// ignore jquery
ignore: [function(name){
- if(name.indexOf("jquery") === 0) {
+ if(name.indexOf("jquery") === 0 || name.indexOf("kefir") === 0) {
return true;
} else {
return false;
}
}],
- exports: {"jquery": "jQuery", "can-util/namespace": "can"},
+ exports: {"jquery": "jQuery", "can-util/namespace": "can", "kefir": "Kefir"},
removeDevelopmentCode: false
}
}
@@ -41,11 +41,15 @@ The best place to start is the [guides/chat].
It's only an hour, and CanJS will be showing off all of it's best features while you build
a real time chat application. You build the whole thing in a JSBin.
-Next, you'll want to try the [guides/todomvc]. This takes about 3 hours and touches on
+Next, you'll want to try the [guides/todomvc]. This takes about 1.5 hours and touches on
every core part of CanJS. You can also follow the whole guide in a JSBin.
-After that, you'll want to go through the [guides/pmo]. This is a very in-depth
-look at how CanJS works.
+After that, checkout the [guides/atm]. It takes about 2 hours and shows how to build and __test__
+an ATM machine. It also shows how to composite state. The whole guide is done in a JSBin.
+
+You might also want to to go through DoneJS's [Place My Order Guide](https://donejs.com/place-my-order.html). This is a very in-depth
+look at how CanJS works within the context of a wide variety of other tools. This guide takes
+about 8 hours.
Finally, when you're just about to commit, read [guides/setup] to learn how to setup
CanJS for your particular environment.
@@ -8,14 +8,73 @@
## Documentation Structure
+CanJS's documentation is broken down by pages for:
+
+ - library collections
+ - packages and modules and their exports
+ - functions, properties, and type definitions (typedefs) related to module exports
+
+For example, [can-define/map/map.prototype.on can-define/map/map.prototype.on] is a
+method that listens to changes on an observable map as follows:
+
+```js
+var DefineMap = require("can-define/map/map");
+
+var map = new DefineMap({name: "Justin"});
+
+map.on("name", function(ev, newVal, oldValue){ ... })
+```
+
+`.on` is a function the `prototype` of the `DefineMap` export of the `can-define/map/map`
+module. The `can-define/map/map` is part of CanJS's [can-core] collection.
+
+So understanding CanJS's API pages are about understanding the relationships between:
+
+- library collections
+- packages and modules and their exports
+- functions, properties, and type definitions (typedefs) related to module exports
+
+... and what's documented on those pages.
+
+### Library Collection pages
+
The API docs are divided in 4 parts:
-- Core
-- Ecosystem
-- Infrastructure
-- Legacy
+- [can-core]
+- [can-ecosystem]
+- [can-infrastructure]
+- [can-legacy]
+
+The [can-core] collection contains the documentation for the libraries that
+are use most commonly and directly within a CanJS application. This is where the Model-View-ViewModel
+libraries of CanJS are documented.
+
+The [can-ecosystem] collection contains less commonly used libraries or libraries that aren't quite core ready yet. The most commonly used libraries here are [can-fixture], [can-stache-converters], and [can-jquery].
+
+The [can-infrastructure] collection contains the utility libraries that power the core and ecoystem
+collection. Often, this functionality is used indirectly. For example, the [can-event] mixin
+is used to add `on`, `off`, and `dispatch` methods to [can-define] and [can-compute]. And, [can-util] contains a wide variety of low-level DOM and JavaScript utilities.
+
+Sometimes [can-infrastructure] is used directly. The most important examples are:
+
+ - [can-event/batch/batch] is used to batch changes for faster performance.
+ - [can-util/dom/attr/attr] provides special [can-util/dom/attr/attr.special.focused] and [can-util/dom/attr/attr.special.values] attributes that [can-stache-bindings] can be bound to.
+ - [can-util/dom/events/events] provides special [can-util/dom/events/attributes/attributes],
+ [can-util/dom/events/inserted/inserted], and [can-util/dom/events/removed/removed] events.
+ - [can-view-callbacks] lets you register behavior for custom elements and attributes.
+
+Finally, the [can-legacy] collection. This is for libraries that are no longer under active
+development. Hopefully, you aren't there very often.
+
+> A collection page acts as an overview and cheat sheet for the modules and functionality
+contained within the collection.
+
+## Package and Module Pages
+
+> A package or module documents the functionality of the export and provides an overview of
+> all functionality contained within the module or package.
-## Module Documentation
+## Functions, Properties, and Typedef pages
- Document what the module exports
- Signatures
@@ -1,5 +1,4 @@
@page guides/pmo Place My Order Guide
-@parent guides/experiment 4
@disableTableOfContents
@body
View
@@ -41,6 +41,7 @@
"can-construct-super": "3.0.0",
"can-control": "3.0.2",
"can-define": "1.0.0",
+ "can-define-stream": "^0.0.2",
"can-ejs": "^3.0.0",
"can-event": "3.0.1",
"can-fixture": "1.0.0",
@@ -58,8 +59,9 @@
"can-stache": "3.0.1",
"can-stache-bindings": "3.0.1",
"can-stache-converters": "3.0.1",
+ "can-stream": "^0.0.4",
"can-util": "3.0.1",
- "can-vdom": "3.0.0-pre.1",
+ "can-vdom": "3.0.1",
"can-view-autorender": "3.0.0",
"can-view-callbacks": "3.0.0",
"can-view-href": "3.0.0",

0 comments on commit ea3a480

Please sign in to comment.