From d4f51f933b9ce21e752314e02babedb37fe47e00 Mon Sep 17 00:00:00 2001 From: Shaun Mahood Date: Sun, 28 Aug 2016 09:40:00 -0600 Subject: [PATCH 01/12] Docs navigation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add navigation to bottom of docs that don’t have it, update existing to match current doc structure --- docs/Basic-App-Structure.md | 5 +++++ docs/Effects.md | 5 +++++ docs/Interceptors.md | 5 +++++ docs/Loading-Initial-Data.md | 2 +- docs/Namespaced-Keywords.md | 5 +++++ docs/Navigation.md | 8 +++++++- docs/Talking-To-Servers.md | 4 ++++ docs/coeffects.md | 4 ++++ 8 files changed, 36 insertions(+), 2 deletions(-) diff --git a/docs/Basic-App-Structure.md b/docs/Basic-App-Structure.md index 42267add9..50ce1f850 100644 --- a/docs/Basic-App-Structure.md +++ b/docs/Basic-App-Structure.md @@ -57,3 +57,8 @@ src ``` Continue to [Navigation](Navigation.md) to learn how to switch between panels of a larger app. + +--- +Previous: [CoEffects](coeffects.md)       +Up: [Index](Readme.md)       +Next: [Navigation](navigation.md) diff --git a/docs/Effects.md b/docs/Effects.md index 42daf7fef..917428385 100644 --- a/docs/Effects.md +++ b/docs/Effects.md @@ -355,3 +355,8 @@ usage: Create a PR to include yours in this list. XXX maybe put this list into the Wiki, so editable by all. + +--- +Previous: [Interceptors](Interceptors.md)       +Up: [Index](Readme.md)       +Next: [CoEffects](coeffects.md) diff --git a/docs/Interceptors.md b/docs/Interceptors.md index 68e27199c..78bde7695 100644 --- a/docs/Interceptors.md +++ b/docs/Interceptors.md @@ -380,3 +380,8 @@ To use them, first require them: (:require [re-frame.core :refer [debug path]]) ``` + +--- +Previous: [Effectful Handlers](EffectfulHandlers.md)       +Up: [Index](Readme.md)       +Next: [Effects](Effects.md) diff --git a/docs/Loading-Initial-Data.md b/docs/Loading-Initial-Data.md index cb0449942..d1059eb5a 100644 --- a/docs/Loading-Initial-Data.md +++ b/docs/Loading-Initial-Data.md @@ -216,7 +216,7 @@ The next Tutorial will show you how. --- -Previous: [Interceptors](Interceptors.md)       +Previous: [Namespaced Keywords](Namespaced-Keywords.md)       Up: [Index](Readme.md)       Next: [Talking To Servers](Talking-To-Servers.md) diff --git a/docs/Namespaced-Keywords.md b/docs/Namespaced-Keywords.md index f2b9ae693..6fe019f6b 100644 --- a/docs/Namespaced-Keywords.md +++ b/docs/Namespaced-Keywords.md @@ -19,3 +19,8 @@ fiction. I can have the keyword `:panel1/edit` even though Naturally, you'll take advantage of this by using keyword namespaces which are both unique and descriptive. + +--- +Previous: [Navigation](Navigation.md)       +Up: [Index](Readme.md)       +Next: [Loading Initial Data](Loading-Initial-Data.md) \ No newline at end of file diff --git a/docs/Navigation.md b/docs/Navigation.md index 04091f488..89530239e 100644 --- a/docs/Navigation.md +++ b/docs/Navigation.md @@ -19,6 +19,7 @@ When the user does something navigation-ish (selects a tab, a dropdown or someth ``` A high level reagent view has a subscription to :active-panel and will switch to the associated panel. + ```clj (re-frame/reg-sub :active-panel @@ -43,7 +44,12 @@ A high level reagent view has a subscription to :active-panel and will switch to (condp = @active ;; or you could look up in a map :panel1 [panel1] :panel2 [panel2])]))) - ``` + Continue to [Namespaced Keywords](Namespaced-Keywords.md) to reduce clashes on ids. + +--- +Previous: [Navigation](Navigation.md)       +Up: [Index](Readme.md)       +Next: [Namespaced Keywords](Namespaced-Keywords.md) diff --git a/docs/Talking-To-Servers.md b/docs/Talking-To-Servers.md index f4aa0862e..07410cfe8 100644 --- a/docs/Talking-To-Servers.md +++ b/docs/Talking-To-Servers.md @@ -113,6 +113,7 @@ In the 2nd version, we use the alternative registration function, `reg-event-fx` You may soon feel confident enough to write your own. Here's our rewrite: + ```clj (ns my.app.events (:require @@ -138,3 +139,6 @@ Notes: +--- +Previous: [Talking To Servers](Talking-To-Servers.md)       +Up: [Index](Readme.md)       diff --git a/docs/coeffects.md b/docs/coeffects.md index 296c8bb56..f9c56a827 100644 --- a/docs/coeffects.md +++ b/docs/coeffects.md @@ -267,3 +267,7 @@ In note form: 5. We must have previously registered a cofx handler via `reg-cofx` +--- +Previous: [Effects](Effects.md)       +Up: [Index](Readme.md)       +Next: [Basic App Structure](Basic-App-Structure.md) From ed19f36376859bd2e81fa360b85fdd894b495a45 Mon Sep 17 00:00:00 2001 From: Shaun Mahood Date: Sun, 28 Aug 2016 09:41:52 -0600 Subject: [PATCH 02/12] Fix typo --- docs/Basic-App-Structure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Basic-App-Structure.md b/docs/Basic-App-Structure.md index 50ce1f850..30dd48c0d 100644 --- a/docs/Basic-App-Structure.md +++ b/docs/Basic-App-Structure.md @@ -61,4 +61,4 @@ Continue to [Navigation](Navigation.md) to learn how to switch between panels of --- Previous: [CoEffects](coeffects.md)       Up: [Index](Readme.md)       -Next: [Navigation](navigation.md) +Next: [Navigation](Navigation.md) From 2ebff403731f73bcf709a2047f8e921e01519ecf Mon Sep 17 00:00:00 2001 From: Shaun Mahood Date: Sun, 28 Aug 2016 09:50:15 -0600 Subject: [PATCH 03/12] Docs Navigation Fix links to Index and wrong navigation links --- docs/Basic-App-Structure.md | 2 +- docs/EffectfulHandlers.md | 2 +- docs/Effects.md | 2 +- docs/Interceptors.md | 2 +- docs/Loading-Initial-Data.md | 2 +- docs/Namespaced-Keywords.md | 2 +- docs/Navigation.md | 2 +- docs/Subscribing-To-External-Data.md | 3 +++ docs/Talking-To-Servers.md | 5 +++-- docs/coeffects.md | 2 +- 10 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/Basic-App-Structure.md b/docs/Basic-App-Structure.md index 30dd48c0d..3749b52d1 100644 --- a/docs/Basic-App-Structure.md +++ b/docs/Basic-App-Structure.md @@ -60,5 +60,5 @@ Continue to [Navigation](Navigation.md) to learn how to switch between panels of --- Previous: [CoEffects](coeffects.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Navigation](Navigation.md) diff --git a/docs/EffectfulHandlers.md b/docs/EffectfulHandlers.md index d1cf830fe..5fc2bd456 100644 --- a/docs/EffectfulHandlers.md +++ b/docs/EffectfulHandlers.md @@ -393,6 +393,6 @@ the mechanism by which event handlers are executed. That knowledge will give us to then, as a next step, better understand coeffects and effects. We'll soon be writing our own. --- -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Interceptors](Interceptors.md) diff --git a/docs/Effects.md b/docs/Effects.md index 917428385..1929b97f3 100644 --- a/docs/Effects.md +++ b/docs/Effects.md @@ -358,5 +358,5 @@ XXX maybe put this list into the Wiki, so editable by all. --- Previous: [Interceptors](Interceptors.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [CoEffects](coeffects.md) diff --git a/docs/Interceptors.md b/docs/Interceptors.md index 78bde7695..84fa862da 100644 --- a/docs/Interceptors.md +++ b/docs/Interceptors.md @@ -383,5 +383,5 @@ To use them, first require them: --- Previous: [Effectful Handlers](EffectfulHandlers.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Effects](Effects.md) diff --git a/docs/Loading-Initial-Data.md b/docs/Loading-Initial-Data.md index d1059eb5a..20aed841f 100644 --- a/docs/Loading-Initial-Data.md +++ b/docs/Loading-Initial-Data.md @@ -217,7 +217,7 @@ The next Tutorial will show you how. --- Previous: [Namespaced Keywords](Namespaced-Keywords.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Talking To Servers](Talking-To-Servers.md) diff --git a/docs/Namespaced-Keywords.md b/docs/Namespaced-Keywords.md index 6fe019f6b..4bc801a5b 100644 --- a/docs/Namespaced-Keywords.md +++ b/docs/Namespaced-Keywords.md @@ -22,5 +22,5 @@ which are both unique and descriptive. --- Previous: [Navigation](Navigation.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Loading Initial Data](Loading-Initial-Data.md) \ No newline at end of file diff --git a/docs/Navigation.md b/docs/Navigation.md index 89530239e..e4151166c 100644 --- a/docs/Navigation.md +++ b/docs/Navigation.md @@ -51,5 +51,5 @@ Continue to [Namespaced Keywords](Namespaced-Keywords.md) to reduce clashes on i --- Previous: [Navigation](Navigation.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Namespaced Keywords](Namespaced-Keywords.md) diff --git a/docs/Subscribing-To-External-Data.md b/docs/Subscribing-To-External-Data.md index 35e738342..54395bc14 100644 --- a/docs/Subscribing-To-External-Data.md +++ b/docs/Subscribing-To-External-Data.md @@ -236,3 +236,6 @@ data into HTML and nothing more. they absolutely do not do imperative stuff. Use one of the two alternatives described above. +--- +Previous: [Talking to Servers](Talking-To-Servers.md)       +Up: [Index](README.md)       diff --git a/docs/Talking-To-Servers.md b/docs/Talking-To-Servers.md index 07410cfe8..78de6159a 100644 --- a/docs/Talking-To-Servers.md +++ b/docs/Talking-To-Servers.md @@ -140,5 +140,6 @@ Notes: --- -Previous: [Talking To Servers](Talking-To-Servers.md)       -Up: [Index](Readme.md)       +Previous: [Loading Initial Data](Loading-Initial-Data.md)       +Up: [Index](README.md)       +Next: [Subscribing to External Data](Subscribing-To-External-Data.md) diff --git a/docs/coeffects.md b/docs/coeffects.md index f9c56a827..ee1bcd9ed 100644 --- a/docs/coeffects.md +++ b/docs/coeffects.md @@ -269,5 +269,5 @@ In note form: --- Previous: [Effects](Effects.md)       -Up: [Index](Readme.md)       +Up: [Index](README.md)       Next: [Basic App Structure](Basic-App-Structure.md) From 436bd5917b66a87a27696c8f9a2e60332e1eb375 Mon Sep 17 00:00:00 2001 From: Shaun Mahood Date: Sun, 28 Aug 2016 09:55:29 -0600 Subject: [PATCH 04/12] Fix docs navigation in navigation doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Quite the commit message, isn’t it? --- docs/Navigation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Navigation.md b/docs/Navigation.md index e4151166c..8fb27852c 100644 --- a/docs/Navigation.md +++ b/docs/Navigation.md @@ -50,6 +50,6 @@ A high level reagent view has a subscription to :active-panel and will switch to Continue to [Namespaced Keywords](Namespaced-Keywords.md) to reduce clashes on ids. --- -Previous: [Navigation](Navigation.md)       +Previous: [Basic App Structure](Basic-App-Structure.md)       Up: [Index](README.md)       Next: [Namespaced Keywords](Namespaced-Keywords.md) From a0679e12a2dfea6acd731d3150aaf4a92c355470 Mon Sep 17 00:00:00 2001 From: Mike Thompson Date: Mon, 29 Aug 2016 13:11:15 +1000 Subject: [PATCH 05/12] More docs --- .idea/codeStyleSettings.xml | 1 + docs/README.md | 9 ++- docs/The-ref-frame-logo.md | 45 +++++++++++++ docs/Using-Stateful-JS-Components.md | 94 ++++++++++++++++++++++++++++ images/logo/README.md | 37 +---------- 5 files changed, 150 insertions(+), 36 deletions(-) create mode 100644 docs/The-ref-frame-logo.md create mode 100644 docs/Using-Stateful-JS-Components.md diff --git a/.idea/codeStyleSettings.xml b/.idea/codeStyleSettings.xml index c374ce3f7..adb5ab925 100644 --- a/.idea/codeStyleSettings.xml +++ b/.idea/codeStyleSettings.xml @@ -12,5 +12,6 @@