improve description

Author: rmorshea

.pre-commit-config.yaml

@@ -9,6 +9,6 @@ repos:
       - id: isort
         name: isort
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v2.7.1
+    rev: v3.0.0-alpha.4
     hooks:
       - id: prettier

README.md

@@ -1,15 +1,12 @@
 # ReactPy · [![Tests](https://github.com/reactive-python/reactpy/workflows/test/badge.svg)](https://github.com/reactive-python/reactpy/actions?query=workflow%3ATest) [![PyPI Version](https://img.shields.io/pypi/v/reactpy.svg)](https://pypi.python.org/pypi/reactpy) [![License](https://img.shields.io/badge/License-MIT-purple.svg)](https://github.com/reactive-python/reactpy/blob/main/LICENSE)
 
-ReactPy is a library for building user interfaces in Python without any Javascript.
-Interfaces made using ReactPy are composed of encapsulated components which look and
-behave similarly to those found in [ReactJS](https://reactjs.org/). These components are
-easy to create and reason about when you're getting started, as well as simple to extend
-and maintain when you need to make changes later.
-
-Whether you need to run a full blown application with a standalone server, or just want
-try things out in a Jupyter Notebook. ReactPy has you covered - it's both approachable
-for those without web development experience while also being powerful enough to grow
-with your ambitions.
+ReactPy is a library for building user interfaces in Python without Javascript. ReactPy
+interfaces are made from components which look and behave similarly to this found in
+[ReactJS](https://reactjs.org/). Designed with simplicity in mind, ReactPy can be used
+by those without web development experience while also being powerful enough to grow
+with your ambitions. It has you covered whether you need to run a full blown application
+with a standalone server, or simply want try things out in a
+[Jupyter Notebook](https://jupyter.org/).
 
 <table>
     <thead>

docs/README.md

@@ -1,13 +1,16 @@
 # ReactPy's Documentation
 
-We provide two main ways to run the docs. Both use `nox` which has a `noxfile.py` at the
-root of the repository. Running the docs with `nox -s docs` will start up an iteractive
-session which will rebuild the docs any time a file is modified. Using `nox -s docs_in_docker` on the other hand, will build a docker image and run the docs from
-there. The latter command mimics how the docs will behave in production. As such, if any
-changes to the core of the documentation are made (i.e. to non-`*.rst` files), then you
-should run a manual test of the documentation using the `docs_in_docker` session.
+We provide two main ways to run the docs. Both use
+[`nox`](https://pypi.org/project/nox/):
 
-If you with to build and run the docs by hand you need to perform two commands, each
+- `nox -s docs` - displayes the docs and rebuilds when files are modified.
+- `nox -s docs-in-docker` - builds a docker image and runs the docs from there.
+
+If any changes to the core of the documentation are made (i.e. to non-`*.rst` files),
+then you should run a manual test of the documentation using the `docs_in_docker`
+session.
+
+If you wish to build and run the docs by hand you need to perform two commands, each
 being run from the root of the repository:
 
 - `sphinx-build -b html docs/source docs/build`

docs/source/index.rst

@@ -38,18 +38,13 @@ ReactPy
     Source Code <https://github.com/reactive-python/reactpy>
     Community <https://github.com/reactive-python/reactpy/discussions>
 
-
-ReactPy is a library for building user interfaces in Python without any Javascript.
-These interfaces are composed of encapsulated :ref:`"components" <Your First
-Components>` which look and behave similarly to those found in `ReactJS
-<https://reactjs.org/>`__. Components made using ReactPy are easy to create and reason
-about when you're getting started, as well as simple to extend and maintain when you
-have to make changes later.
-
-Whether you need to run a full blown application with a standalone server, or just want
-try things out in a Jupyter Notebook. ReactPy has you covered - it's both approachable
-for those without web development experience while also being powerful enough to grow
-with your ambitions.
+ReactPy is a library for building user interfaces in Python without Javascript. ReactPy
+interfaces are made from :ref:`components <Your First Components>` which look and behave
+similarly to this found in `ReactJS <https://reactjs.org/>`__. Designed with simplicity
+in mind, ReactPy can be used by those without web development experience while also
+being powerful enough to grow with your ambitions. It has you covered whether you need
+to run a full blown application with a standalone server, or simply want try things out
+in a `Jupyter Notebook <https://jupyter.org/>`__.
 
 
 At a Glance