Skip to content

Commit

Permalink
misc doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
rmorshea committed Mar 4, 2021
1 parent 64f3aed commit 043cd0b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
4 changes: 2 additions & 2 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Contributing
The
`Code of Conduct <https://github.com/idom-team/idom/blob/main/CODE_OF_CONDUCT.md>`__
applies in all community spaces. If you are not familiar with our Code of Conduct
policy, take a minute to read the policy before starting with your first contribution.
policy, take a minute to read it before making your first contribution.

The IDOM team welcomes contributions and contributors of all kinds - whether they come
as code changes, participation in the discussions, opening issues and pointing out bugs,
Expand All @@ -25,7 +25,7 @@ you can help move this project and community forward!
* - `Where to report issues <https://github.com/idom-team/idom/issues>`__
- Tell us about any problems you're having

* - :ref:`How to contribute Code <Developer Workflow>`
* - :ref:`How to contribute Code <Developer Guide>`
- Make and review code changes

* - `Other related projects <https://github.com/idom-team>`__
Expand Down
15 changes: 8 additions & 7 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ Since it's likely a lot to take in at once, we'll break it down piece by piece:
:lines: 4-5
:linenos:

The ``idom.component`` decorator creates a :ref:`Component <Stateful Components>` constructor
whose which is "rendered" by the function below it. To create a Component instance we call
``Slideshow()`` with the same arguments as its render function. The render function of a
Component returns a data structure that depicts a user interface, or in more technical terms
a Document Object Model (DOM). We call this structural representation of the DOM a
`Virtual DOM`__ (VDOM) - a term familiar to those who work with `ReactJS`_. In the case of
``Slideshow`` it will return a VDOM representing an image which, when clicked, will change.
The ``idom.component`` decorator creates a :ref:`Component <Stateful Components>`
constructor which is "rendered" by the function below it. To create a Component instance
we call ``Slideshow()`` with the same arguments as its render function. The render
function of a Component returns a data structure that depicts a user interface, or in
more technical terms a Document Object Model (DOM). We call this structural
representation of the DOM a `Virtual DOM`__ (VDOM) - a term familiar to those who work
with `ReactJS`_. In the case of ``Slideshow`` it will return a VDOM representing an
image which, when clicked, will change.

__ https://reactjs.org/docs/faq-internals.html#what-is-the-virtual-dom

Expand Down

0 comments on commit 043cd0b

Please sign in to comment.