Skip to content

Commit 043cd0b

Browse files
committed
misc doc updates
1 parent 64f3aed commit 043cd0b

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

Diff for: docs/source/contributing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Contributing
66
The
77
`Code of Conduct <https://github.com/idom-team/idom/blob/main/CODE_OF_CONDUCT.md>`__
88
applies in all community spaces. If you are not familiar with our Code of Conduct
9-
policy, take a minute to read the policy before starting with your first contribution.
9+
policy, take a minute to read it before making your first contribution.
1010

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

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

3131
* - `Other related projects <https://github.com/idom-team>`__

Diff for: docs/source/getting-started.rst

+8-7
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@ Since it's likely a lot to take in at once, we'll break it down piece by piece:
1414
:lines: 4-5
1515
:linenos:
1616

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

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

0 commit comments

Comments
 (0)