Skip to content

Commit ef9b6e4

Browse files
committed
misc changes
1 parent a456be0 commit ef9b6e4

File tree

6 files changed

+65
-29
lines changed

6 files changed

+65
-29
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Dynamic Layout Structure
1+
Dynamic Element Children
22
========================
33

44
Under construction :)

docs/source/creating-interfaces/index.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,20 @@ Creating Interfaces
88
your-first-component
99
parametrizing-components
1010
conditional-rendering
11-
dynamic-layout-structure
11+
dynamic-element-children
1212

1313
.. dropdown:: :octicon:`bookmark-fill;2em` What You'll Learn
1414
:color: info
1515
:animate: fade-in
1616

1717
.. grid:: 2
1818

19-
.. grid-item-card:: :octicon:`mortar-board` Intro to HTML
19+
.. grid-item-card:: :octicon:`mortar-board` HTML with IDOM
2020
:link: html-with-idom
2121
:link-type: doc
2222

23-
Learn how to construct HTML layouts with IDOM.
23+
Learn how to construct HTML layouts with IDOM and the underlying data
24+
structure we use to represent them.
2425

2526
.. grid-item-card:: :octicon:`package` Your First Component
2627
:link: your-first-component
@@ -39,13 +40,15 @@ Creating Interfaces
3940
:link: conditional-rendering
4041
:link-type: doc
4142

42-
Use what you've learned so far to add conditional logic to your components.
43+
Use what you've learned so far to render display different views depending
44+
on a what a component's inputs are.
4345

44-
.. grid-item-card:: :octicon:`versions` Dynamic Layout Structure
45-
:link: dynamic-layout-structure
46+
.. grid-item-card:: :octicon:`versions` Dynamic Element Children
47+
:link: dynamic-element-children
4648
:link-type: doc
4749

48-
Understand how IDOM keeps track of changing layout structures.
50+
Understand how to correctly render using lists of child elements that
51+
may change in length or order
4952

5053
IDOM is a Python package for making user interfaces (UI). These interfaces are built
5154
from small elements of functionality like buttons text and images. IDOM allows you to
@@ -94,7 +97,9 @@ To recreate the same thing in IDOM you would write:
9497

9598
:octicon:`book` Read More
9699
^^^^^^^^^^^^^^^^^^^^^^^^^
97-
Learn how to construct HTML layouts with IDOM.
100+
101+
Learn how to construct HTML layouts with IDOM and the underlying data structure we
102+
use to represent them.
98103

99104

100105
Section 2: Your First Component
@@ -109,5 +114,5 @@ Section 4: Conditional Rendering
109114
--------------------------------
110115

111116

112-
Section 5: Dynamic Layout Structure
117+
Section 5: Dynamic Element Children
113118
-----------------------------------
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Writing Your Own client
1+
Writing Your Own Client
22
=======================
33

44
Under construction :)

docs/source/getting-started/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,16 @@ Getting Started
2727
See the ways that IDOM can be run with servers or be embedded in existing
2828
applications.
2929

30-
The fastest way to get started with IDOM is to try it out in a Juptyer Notebook:
30+
The fastest way to get started with IDOM is to try it out in a Juptyer Notebook. If you
31+
want to use a Notebook to work through the examples shown in this documentation, you'll
32+
want to replace calls to ``idom.run(App)`` with a line at the end of each cell that
33+
constructs the ``App()`` in question. If that doesn't make sense, the introductory
34+
notebook linked below will demonstrate how to do this:
3135

3236
.. card::
3337
:link: https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?urlpath=lab/tree/notebooks/introduction.ipynb
3438

35-
.. image:: /_static/idom-in-jupyterlab.gif
39+
.. image:: _static/idom-in-jupyterlab.gif
3640
:scale: 72%
3741
:align: center
3842

@@ -75,6 +79,7 @@ For anything else, report your issue in IDOM's
7579

7680
:octicon:`book` Read More
7781
^^^^^^^^^^^^^^^^^^^^^^^^^
82+
7883
Learn how IDOM can be installed in a variety of different ways - with different web
7984
servers and even in different frameworks.
8085

@@ -97,5 +102,6 @@ code:
97102

98103
:octicon:`book` Read More
99104
^^^^^^^^^^^^^^^^^^^^^^^^^
105+
100106
See the ways that IDOM can be run with servers or be embedded in existing
101107
applications.

docs/source/index.rst

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,15 @@ function.
7171
Learning IDOM
7272
-------------
7373

74-
This documentation is broken up into chapters that introduce you to concepts step by
75-
step with detailed explanations and lots of examples. You should feel free to dive into
76-
any section that seems interesting. While each chapter assumes knowledge from those
77-
that came before, when you encounter a concept you're unfamiliar with you should look
78-
for links that will help direct you to the place where it was originally taught.
74+
This documentation is broken up into chapters and sections that introduce you to
75+
concepts step by step with detailed explanations and lots of examples. You should feel
76+
free to dive into any content that seems interesting. While each chapter assumes
77+
knowledge from those that came before, when you encounter a concept you're unfamiliar
78+
with you should look for links that will help direct you to the place where it was
79+
originally taught.
7980

8081

81-
Chapter 0 - :ref:`Getting Started`
82+
Chapter 1 - :ref:`Getting Started`
8283
-----------------------------------
8384

8485
If you want to follow along with examples in the sections that follow, you'll want to
@@ -89,36 +90,60 @@ IDOM within a Jupyter Notebook, this is where you can learn how to do those thin
8990

9091
.. grid:: 2
9192

92-
.. grid-item-card::
93-
:link: getting-started/index.html#quick-install
93+
.. grid-item::
9494

9595
.. image:: _static/install-and-run-idom.gif
9696

97-
.. grid-item-card::
98-
:link: getting-started/index.html
97+
.. grid-item::
9998

100-
.. image:: _static/idom-in-jupyterlab.gif
99+
.. image:: getting-started/_static/idom-in-jupyterlab.gif
101100

101+
.. card::
102+
:link: getting-started/index
103+
:link-type: doc
102104

103-
Chapter 1 - :ref:`Creating Interfaces`
105+
:octicon:`book` Read More
106+
^^^^^^^^^^^^^^^^^^^^^^^^^
107+
108+
Learn how IDOM can be installed and run in a variety of different ways - with
109+
different web servers and frameworks as well as being embedded into existing apps.
110+
111+
112+
Chapter 2 - :ref:`Creating Interfaces`
104113
--------------------------------------
105114

106-
...
115+
IDOM is a Python package for making user interfaces (UI). These interfaces are built
116+
from small elements of functionality like buttons text and images. IDOM allows you to
117+
combine these elements into reusable, nestable :ref:`"components" <your first
118+
component>`. In the sections that follow you'll learn how these UI elements are created
119+
and organized into components. Then, you'll use components to customize and
120+
conditionally display more complex UIs.
121+
122+
Some sort of examples here...
123+
124+
.. card::
125+
:link: creating-interfaces/index
126+
:link-type: doc
127+
128+
:octicon:`book` Read More
129+
^^^^^^^^^^^^^^^^^^^^^^^^^
130+
131+
Learn stuff...
107132

108133

109-
Chapter 2 - :ref:`Adding Interactivity`
134+
Chapter 3 - :ref:`Adding Interactivity`
110135
---------------------------------------
111136

112137
...
113138

114139

115-
Chapter 3 - :ref:`Managing State`
140+
Chapter 4 - :ref:`Managing State`
116141
---------------------------------
117142

118143
...
119144

120145

121-
Chapter 4 - :ref:`Escape Hatches`
146+
Chapter 5 - :ref:`Escape Hatches`
122147
---------------------------------
123148

124149
...

0 commit comments

Comments
 (0)