Skip to content

Commit a2be8f1

Browse files
committed
fix misc refs in docs
1 parent 9426d7d commit a2be8f1

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/source/creating-interfaces/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Creating Interfaces
3737
IDOM is a Python package for making user interfaces (UI). These interfaces are built
3838
from small elements of functionality like buttons text and images. IDOM allows you to
3939
combine these elements into reusable, nestable :ref:`"components" <your first
40-
component>`. In the sections that follow you'll learn how these UI elements are created
40+
components>`. In the sections that follow you'll learn how these UI elements are created
4141
and organized into components. Then, you'll use components to customize and
4242
conditionally display more complex UIs.
4343

docs/source/getting-started/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ For anything else, report your issue in IDOM's
8989
Section 2: Running IDOM
9090
-----------------------
9191

92-
Once you've :ref:`installed IDOM <quick install>`. The simplest way to run IDOM is with
93-
the :func:`~idom.server.prefab.run` function. By default this will execute your
92+
Once you've :ref:`installed IDOM <Installing IDOM>`. The simplest way to run IDOM is
93+
with the :func:`~idom.server.prefab.run` function. By default this will execute your
9494
application using one of the builtin server implementations whose dependencies have all
9595
been installed. Running a tiny "hello world" application just requires the following
9696
code:

docs/source/getting-started/running-idom.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Here's the list of available configuration types:
172172
Specific Server Settings
173173
------------------------
174174

175-
The ``Config`` :ref:`described above <Configuring Server Settings>` is meant to be an
175+
The ``Config`` :ref:`described above <Common Server Settings>` is meant to be an
176176
implementation agnostic - all ``Config`` objects support a similar set of options.
177177
However, there are inevitably cases where you need to set up your chosen server using
178178
implementation specific details. For example, you might want to add an extra route to
@@ -263,11 +263,11 @@ embedding one the examples from this documentation into your own webpage:
263263

264264
As mentioned though, this is connecting to the server that is hosting this
265265
documentation. If you want to connect to a view from your own server, you'll need to
266-
change the URL above to one you provide. One way to do this might be to :ref:`add IDOM
267-
to your existing python web server`. Another would be to run IDOM in adjacent web server
268-
instance that you coordinate with something like `NGINX <https://www.nginx.com/>`__. For
269-
the sake of simplicity, we'll assume you do something similar to the following in an
270-
existing Python app:
266+
change the URL above to one you provide. One way to do this might be to :ref:`add to an
267+
existing web server`. Another would be to run IDOM in an adjacent web server instance
268+
that you coordinate with something like `NGINX <https://www.nginx.com/>`__. For the sake
269+
of simplicity, we'll assume you do something similar to the following in an existing
270+
Python app:
271271

272272
.. tab-set::
273273

docs/source/index.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ IDOM
3232
IDOM is a Python web framework for building **interactive websites without needing a
3333
single line of Javascript**. This is accomplished by breaking down complex applications
3434
into nestable and reusable chunks of code called :ref:`"components" <Your First
35-
Component>` that allow you to focus on what your application does rather than how it
35+
Components>` that allow you to focus on what your application does rather than how it
3636
does it.
3737

3838
IDOM is also ecosystem independent. It can be added to existing applications built on a
@@ -63,7 +63,7 @@ which will define the content the application displays. Specifically, it display
6363
of HTML element called an ``h1`` `section heading
6464
<https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements>`__.
6565
Importantly though, a ``@component`` decorator has been applied to the ``App`` function
66-
to turn it into a :ref:`component <Your First Component>`. Finally, we :ref:`run
66+
to turn it into a :ref:`component <Your First Components>`. Finally, we :ref:`run
6767
<Running IDOM>` an application server by passing the ``App`` component to the ``run()``
6868
function.
6969

0 commit comments

Comments
 (0)