start marking sections as under construction

rmorshea · rmorshea · commit 64a38d52e7be · 2021-11-22T23:16:02.000-08:00
diff --git a/docs/source/adding-interactivity/batched-updates.rst b/docs/source/adding-interactivity/batched-updates.rst
@@ -1,4 +1,6 @@
-Batched Updates
-===============
+Batched Updates 🚧
+==================
 
-Under constructions :)
+.. note::
+
+    Under construction 🚧
diff --git a/docs/source/adding-interactivity/components-with-state.rst b/docs/source/adding-interactivity/components-with-state.rst
@@ -4,8 +4,8 @@ Components With State
 Components often need to change what’s on the screen as a result of an interaction. For
 example, typing into the form should update the input field, clicking “next” on an image
 carousel should change which image is displayed, clicking “buy” should put a product in
-the shopping cart. Components need to “remember” things: the current input value, the
-current image, the shopping cart. In IDOM, this kind of component-specific memory is
+the shopping cart. Components need to “remember” things like the current input value,
+the current image, the shopping cart. In IDOM, this kind of component-specific memory is
 called state.
 
 
@@ -52,14 +52,15 @@ which provides:
 Adding State to Components
 --------------------------
 
-To use the ``use_state()`` hook to create a state variable and setter in the
-:ref:`example above <When Variables Aren't Enough>` we'll first import it:
+To create a state variable and state setter with :func:`~idom.core.hooks.use_state` hook
+as described above, we'll begin by importing it:
 
 .. testcode::
 
     from idom import use_state
 
-Then we'll make the following changes to our code from before:
+Then we'll make the following changes to our code :ref:`from before <When Variables
+Aren't Enough>`:
 
 .. code-block:: diff
 
diff --git a/docs/source/adding-interactivity/dangers-of-mutability.rst b/docs/source/adding-interactivity/dangers-of-mutability.rst
@@ -1,6 +1,6 @@
-The Dangers of Mutability
-=========================
+Dangers of Mutability 🚧
+========================
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/adding-interactivity/index.rst b/docs/source/adding-interactivity/index.rst
@@ -29,39 +29,43 @@ Adding Interactivity
             :link: components-with-state
             :link-type: doc
 
-            ...
+            Allow components to change what they display by saving and updating their
+            state.
 
         .. grid-item-card:: :octicon:`device-camera-video` State as a Snapshot
             :link: state-as-a-snapshot
             :link-type: doc
 
-            ...
+            Under construction 🚧
 
         .. grid-item-card:: :octicon:`issue-opened` Dangers of Mutability
             :link: dangers-of-mutability
             :link-type: doc
 
-            ...
+            Under construction 🚧
 
         .. grid-item-card:: :octicon:`versions` Batched Updates
             :link: batched-updates
             :link-type: doc
 
-            ...
-
-...
+            Under construction 🚧
 
 
 Section 1: Responding to Events
 -------------------------------
 
 IDOM lets you add event handlers to your parts of the interface. This means that you can
-define  synchronous or asynchronous functions that are triggered when a particular user
+define synchronous or asynchronous functions that are triggered when a particular user
 interaction occurs like clicking, hovering, of focusing on form inputs, and more.
 
 .. example:: adding_interactivity/button_prints_message
     :activate-result:
 
+It may feel weird to define a function within a function like this, but doing so allows
+the ``handle_event`` function to access information from within the scope of the
+component. That's important if you want to use any arguments that may have beend passed
+your component in the handler.
+
 .. card::
     :link: responding-to-events
     :link-type: doc
@@ -76,14 +80,31 @@ interaction occurs like clicking, hovering, of focusing on form inputs, and more
 Section 2: Components with State
 --------------------------------
 
+Components often need to change what’s on the screen as a result of an interaction. For
+example, typing into the form should update the input field, clicking a “Comment” button
+should bring up a text input field, clicking “Buy” should put a product in the shopping
+cart. Components need to “remember” things like the current input value, the current
+image, the shopping cart. In IDOM, this kind of component-specific memory is created and
+updated with a "hook" called ``use_state()`` that creates a **state variable** and
+**state setter** respectively:
+
+.. example:: adding_interactivity/adding_state_variable
+    :activate-result:
+
+In IDOM, ``use_state``, as well as any other function whose name starts with ``use``, is
+called a "hook". These are special functions that should only be called while IDOM is
+:ref:`rendering <the rendering process>`. They let you "hook into" the different
+capabilities of IDOM's components of which ``use_state`` is just one (well get into the
+other :ref:`later <managing state>`).
+
 .. card::
     :link: components-with-state
     :link-type: doc
 
     :octicon:`book` Read More
     ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    ...
+    Allow components to change what they display by saving and updating their state.
 
 
 Section 3: State as a Snapshot
diff --git a/docs/source/adding-interactivity/state-as-a-snapshot.rst b/docs/source/adding-interactivity/state-as-a-snapshot.rst
@@ -1,4 +1,6 @@
-State as a Snapshot
-===================
+State as a Snapshot 🚧
+======================
 
-Under constructions :)
+.. note::
+
+    Under construction 🚧
diff --git a/docs/source/escape-hatches/class-components.rst b/docs/source/escape-hatches/class-components.rst
@@ -3,4 +3,4 @@ Class Components
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/escape-hatches/index.rst b/docs/source/escape-hatches/index.rst
@@ -1,5 +1,7 @@
-Escape Hatches
-==============
+.. _Escape Hatches:
+
+Escape Hatches 🚧
+=================
 
 .. toctree::
     :hidden:
@@ -12,4 +14,4 @@ Escape Hatches
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/escape-hatches/writing-your-own-client.rst b/docs/source/escape-hatches/writing-your-own-client.rst
@@ -3,4 +3,4 @@ Writing Your Own Client
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/escape-hatches/writing-your-own-server.rst b/docs/source/escape-hatches/writing-your-own-server.rst
@@ -3,4 +3,4 @@ Writing Your Own Server
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,12 +10,12 @@ IDOM
     adding-interactivity/index
     managing-state/index
     escape-hatches/index
+    understanding-idom/index
 
 .. toctree::
     :hidden:
     :caption: Other Resources
 
-    understanding-idom/index
     developing-idom/index
     reference-material/index
     credits-and-licenses
@@ -135,14 +135,31 @@ raw data:
 Chapter 3 - :ref:`Adding Interactivity`
 ---------------------------------------
 
+Components often need to change what’s on the screen as a result of an interaction. For
+example, typing into the form should update the input field, clicking a “Comment” button
+should bring up a text input field, clicking “Buy” should put a product in the shopping
+cart. Components need to “remember” things like the current input value, the current
+image, the shopping cart. In IDOM, this kind of component-specific memory is created and
+updated with a "hook" called ``use_state()`` that creates a **state variable** and
+**state setter** respectively:
+
+.. example:: adding_interactivity/adding_state_variable
+    :activate-result:
+
+In IDOM, ``use_state``, as well as any other function whose name starts with ``use``, is
+called a "hook". These are special functions that should only be called while IDOM is
+:ref:`rendering <the rendering process>`. They let you "hook into" the different
+capabilities of IDOM's components of which ``use_state`` is just one (well get into the
+other :ref:`later <managing state>`).
+
 .. card::
     :link: adding-interactivity/index
     :link-type: doc
 
     :octicon:`book` Read More
     ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    ...
+    Under construction 🚧
 
 
 
@@ -156,7 +173,7 @@ Chapter 4 - :ref:`Managing State`
     :octicon:`book` Read More
     ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    ...
+    Under construction 🚧
 
 
 
@@ -170,5 +187,18 @@ Chapter 5 - :ref:`Escape Hatches`
     :octicon:`book` Read More
     ^^^^^^^^^^^^^^^^^^^^^^^^^
 
-    ...
+    Under construction 🚧
+
+
+Chapter 6 - :ref:`Understanding IDOM`
+-------------------------------------
+
+.. card::
+    :link: escape-hatches/index
+    :link-type: doc
+
+    :octicon:`book` Read More
+    ^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    Under construction 🚧
 
diff --git a/docs/source/managing-state/index.rst b/docs/source/managing-state/index.rst
@@ -1,5 +1,7 @@
-Managing State
-==============
+.. _Managing State:
+
+Managing State 🚧
+=================
 
 .. toctree::
     :hidden:
@@ -11,6 +13,4 @@ Managing State
     when-to-reset-state
     writing-tests
 
-.. note::
-
-    Under construction 👷
+Under construction 🚧
diff --git a/docs/source/managing-state/keeping-components-pure.rst b/docs/source/managing-state/keeping-components-pure.rst
@@ -3,4 +3,4 @@ Keeping Components Pure
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/managing-state/logical-flow-of-state.rst b/docs/source/managing-state/logical-flow-of-state.rst
@@ -3,4 +3,4 @@ Logical Flow of State
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/managing-state/shared-component-state.rst b/docs/source/managing-state/shared-component-state.rst
@@ -3,4 +3,4 @@ Shared Component State
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/managing-state/structuring-your-state.rst b/docs/source/managing-state/structuring-your-state.rst
@@ -3,4 +3,4 @@ Structuring Your State
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/managing-state/when-to-reset-state.rst b/docs/source/managing-state/when-to-reset-state.rst
@@ -3,4 +3,4 @@ When to Reset State
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/managing-state/writing-tests.rst b/docs/source/managing-state/writing-tests.rst
@@ -3,4 +3,4 @@ Writing Tests
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/reference-material/browser-events.rst b/docs/source/reference-material/browser-events.rst
@@ -1,11 +1,17 @@
-Browser Events
-==============
+.. _Browser Events:
+
+Browser Events 🚧
+=================
 
 The event types below are triggered by an event in the bubbling phase. To register an
 event handler for the capture phase, append Capture to the event name; for example,
 instead of using ``onClick``, you would use ``onClickCapture`` to handle the click event
 in the capture phase.
 
+.. note::
+
+    Under construction 🚧
+
 
 Clipboard Events
 ----------------
diff --git a/docs/source/reference-material/javascript-api.rst b/docs/source/reference-material/javascript-api.rst
@@ -1,6 +1,8 @@
+.. _Javascript API:
+
 Javascript API
 ==============
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/reference-material/specifications.rst b/docs/source/reference-material/specifications.rst
@@ -162,7 +162,7 @@ JSON Patch
 
 Updates to VDOM modules are sent using the `JSON Patch`_ specification.
 
-... this section is still under construction :)
+... this section is still Under construction 🚧
 
 
 .. Links
diff --git a/docs/source/understanding-idom/index.rst b/docs/source/understanding-idom/index.rst
@@ -1,5 +1,7 @@
-Understanding IDOM
-==================
+.. _Understanding IDOM:
+
+Understanding IDOM 🚧
+=====================
 
 .. toctree::
     :hidden:
diff --git a/docs/source/understanding-idom/layout-render-servers.rst b/docs/source/understanding-idom/layout-render-servers.rst
@@ -3,4 +3,4 @@ Layout Render Servers
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/understanding-idom/representing-html.rst b/docs/source/understanding-idom/representing-html.rst
@@ -3,7 +3,7 @@ Representing HTML
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
 
 We've already discussed how to contruct HTML with IDOM in a :ref:`previous section <HTML
 with IDOM>`, but we skimmed over the question of the data structure we use to represent
diff --git a/docs/source/understanding-idom/the-rendering-pipeline.rst b/docs/source/understanding-idom/the-rendering-pipeline.rst
@@ -5,4 +5,4 @@ The Rendering Pipeline
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/understanding-idom/the-rendering-process.rst b/docs/source/understanding-idom/the-rendering-process.rst
@@ -5,4 +5,4 @@ The Rendering Process
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/understanding-idom/what-are-components.rst b/docs/source/understanding-idom/what-are-components.rst
@@ -3,4 +3,4 @@ What Are Components?
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧
diff --git a/docs/source/understanding-idom/why-idom-needs-keys.rst b/docs/source/understanding-idom/why-idom-needs-keys.rst
@@ -3,4 +3,4 @@ Why IDOM Needs Keys
 
 .. note::
 
-    Under construction 👷
+    Under construction 🚧

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Class Components`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Writing Your Own Client`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Writing Your Own Server`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Keeping Components Pure`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Logical Flow of State`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Shared Component State`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Structuring Your State`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ When to Reset State`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Writing Tests`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`
Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@ Layout Render Servers`
`3`	`3`
`4`	`4`	`.. note::`
`5`	`5`
`6`		`- Under construction 👷`
	`6`	`+ Under construction 🚧`