docs(todo-example): clarify schema comments (#12)

becomingbabyman · web-flow · commit 1c4f1e80988b · 2020-11-11T15:53:27.000-05:00
diff --git a/js/todo-example.jsx b/js/todo-example.jsx
@@ -10,28 +10,32 @@ export const App = () => {
 }
 
 const config = {
-  // Schema is optional. Add as much or as little as you want.
+  // Schema is only used to enforce 
+  // unique constraints and relationships.
+  // It is not a type system, yet.
   schema: {
-    user: { name: { type: 'string' } },
     project: { name: { unique: 'identity' } },
     todo: {
       // refs are relationships
       project: { type: 'ref' },
       owner: { type: 'ref' }
     }
   },
+  // Initial data let's you conveniently transact some 
+  // starting data on DB creation to hydrate your components.
   initialData: [
     {
       todoFilter: {
-        // identity is a special attribute for user generated ids
-        // E.g. this is a setting that should be easy to lookup by name
+        // identity is a special unique attribute for user generated ids
+        // E.g. todoFilters are settings that should be easy to lookup by their identity
         identity: 'todoFilters',
         showCompleted: true,
         project: 0
       }
     }, {
       user: {
-        // negative numbers can be used as temporary ids in a transaction
+        // Negative numbers can be used as temporary ids in a transaction.
+        // Use them to relate multiple entities together at once.
         id: -1, 
         name: 'Stella' 
       }
@@ -87,7 +91,7 @@ const NewTodo = () => {
       transact([{
         todo: {
           name: e.target.elements['todo-name'].value,
-          createdAt: new Date
+          createdAt: new Date()
         }
       }])
       e.target.reset()
diff --git a/src/js_gen/todo-example.js b/src/js_gen/todo-example.js
@@ -24,13 +24,10 @@ const App = () => {
 
 exports.App = App;
 const config = {
-  // Schema is optional. Add as much or as little as you want.
+  // Schema is only used to enforce 
+  // unique constraints and relationships.
+  // It is not a type system, yet.
   schema: {
-    user: {
-      name: {
-        type: 'string'
-      }
-    },
     project: {
       name: {
         unique: 'identity'
@@ -46,17 +43,20 @@ const config = {
       }
     }
   },
+  // Initial data let's you conveniently transact some 
+  // starting data on DB creation to hydrate your components.
   initialData: [{
     todoFilter: {
-      // identity is a special attribute for user generated ids
-      // E.g. this is a setting that should be easy to lookup by name
+      // identity is a special unique attribute for user generated ids
+      // E.g. todoFilters are settings that should be easy to lookup by their identity
       identity: 'todoFilters',
       showCompleted: true,
       project: 0
     }
   }, {
     user: {
-      // negative numbers can be used as temporary ids in a transaction
+      // Negative numbers can be used as temporary ids in a transaction.
+      // Use them to relate multiple entities together at once.
       id: -1,
       name: 'Stella'
     }
