Apply suggestions from code review

Co-authored-by: Grégoire Paris <[email protected]>

Author: linawolf

docs/cli/configuration.rst

@@ -8,7 +8,7 @@ The cli tool is able to read configuration from a ``guides.xml`` file.
 You should put this file in the current working directory where you execute
 the tool. Generally speaking, this is the root of your project.
 
-Using a configuration file allows you to set project specific settings and
+Using a configuration file allows you to set project-specific settings and
 keep them under version control. Not all options available in the configuration
 are available on the command line. Such as the :ref:`extension configuration`.
 

docs/cli/index.rst

@@ -12,7 +12,7 @@ Create your first documentation
 ===============================
 
 After :doc:`/installation` you can directly start to create your first documentation.
-to do this create a new directory named ``docs`` and create a file called ``index.rst`` in it.
+to do this, create a new directory named ``docs`` and create a file called ``index.rst`` in it.
 
 .. code-block:: rst
 
@@ -49,6 +49,6 @@ to learn more about the configuration.
 Extending
 =========
 
-Like any other component in this repository the commandline tool can be extended. This can
-be done using an extension class. And reference this class in the configuration file. Like
+Like any other component in this repository, the commandline tool can be extended. This can
+be done using an extension class, and referencing this class in the configuration file, like
 shown for in the :ref:`.extension-configuration` section.

docs/components/compiler.rst

@@ -9,7 +9,7 @@ Compiler
 This library uses a simplified compiler design. This basically means that our pipeline contains less steps
 than a regular compiler. But its following the same semantics.
 
-stages
+Stages
 ======
 
 Lexing and Parsing
@@ -41,7 +41,7 @@ Extending
 =========
 
 The compiler is designed to be extended. This allows you to remove or add nodes to the AST or mutate the AST in any way
-you like. Compiler extension is mostly done when you want want to do dynamic calulations based on the AST. The mutations
+you like. Compiler extension is mostly done when you want want to do dynamic calculations based on the AST. The mutations
 will not have direct impact on the rendering process. Style changes should be done in the rendering phase.
 
 To read more about extending the compiler, see :ref:`extending_compiler`.

docs/developers/compiler.rst

@@ -16,7 +16,7 @@ If you want to extend the compiler to support new features there are two options
 NodeTransformer
 ===============
 
-Node transformers are used to transform specific types of nodes in the AST. This is usefull when you want to remove
+Node transformers are used to transform specific types of nodes in the AST. This is useful when you want to remove
 a node type or manipulate nodes of a specific type. Your new node transformer should implement the :php:class:`phpDocumentor\Guides\Compiler\NodeTransformer`
 interface and you should register it in the dependency injection container.
 
@@ -33,13 +33,13 @@ interface and you should register it in the dependency injection container.
 .. note::
 
     The tag `phpdoc.guides.compiler.nodeTransformers` is used to register the node transformer in the compiler. The higher
-    the priority of the node transformer, the earlier it will be executed. Where higest priority is `PHP_INT_MAX`, lower
+    the priority of the node transformer, the earlier it will be executed. Where highest priority is `PHP_INT_MAX`, lower
     number is lower priority.
 
 CompilerPass
 ============
 
-If you want to do more complex transformations for example transformations that require multiple nodes to be transformed
+If you want to do more complex transformations, for example transformations that require multiple nodes to be transformed
 you should implement a :php:class:`phpDocumentor\Guides\Compiler\CompilerPass`. A compiler pass needs to be registered
 just like a node transformer.
 
@@ -56,5 +56,5 @@ just like a node transformer.
 .. note::
 
     The tag `phpdoc.guides.compiler.passes` is used to register the node transformer in the compiler. The higher
-    the priority of the node transformer, the earlier it will be executed. Where higest priority is `PHP_INT_MAX`, lower
+    the priority of the node transformer, the earlier it will be executed. Where highest priority is `PHP_INT_MAX`, lower
     number is lower priority.

docs/developers/directive.rst

@@ -8,11 +8,11 @@ will do the actual processing of the directive.
 
 .. hint::
 
-   This project contains a lot of directives. You can find them in the :php:namespace:`\phpDocumentor\Guides\RestructuredText\Directives` namespace.
-   Including the way how to use them.
+   This project contains a lot of directives. You can find them in the :php:namespace:`\phpDocumentor\Guides\RestructuredText\Directives` namespace,
+   including the way to use them.
 
-To implement a directive you need to create a class that extends :php:class:`\phpDocumentor\Guides\RestructuredText\Directives\BaseDirective`.
-And register it with the parser using a :ref:`custom extension <developer-extension>`.
+To implement a directive you need to create a class that extends :php:class:`\phpDocumentor\Guides\RestructuredText\Directives\BaseDirective`,
+and register it with the parser using a :ref:`custom extension <developer-extension>`.
 
 .. code-block:: php
     :caption: your-extension.php
@@ -24,7 +24,7 @@ And register it with the parser using a :ref:`custom extension <developer-extens
             ->set(YourDirective::class)
             ->tag('phpdoc.guides.directive');
 
-By design this library distinguishes between three types of directives:
+By design, this library distinguishes between three types of directives:
 
 - :php:class:`phpDocumentor\Guides\RestructuredText\Directives\SubDirective`
   This is the most common directive type. It is used to add a new node type to the document tree that allows you to do
@@ -39,7 +39,7 @@ By design this library distinguishes between three types of directives:
   This is the most advanced directive type. You are on your own here. You need to do everything yourself.
 
 Implement a sub directive
-========================
+=========================
 
 A sub directivehandler is a node with child nodes. The parser will take care of the parsing of the directive content.
 All you need to do is create a node and add the content.

docs/index.rst

@@ -22,7 +22,7 @@ your documentation from `reStructuredText Markup <https://docutils.sourceforge.i
 formats.
 
 Besides the commandline tool it also provides a number of libraries that can be used to build your own application
-to render the supported formats. To any format you want. On these pages is explained how to use the commandline tool
+to render the supported formats, to any format you want. On these pages is explained how to use the commandline tool
 and how to use the libraries.
 
 If you are looking for a complete solution to create a documentation website then you may want to look at

docs/installation.rst

@@ -27,11 +27,11 @@ This will install the commandline tool in the vendor/bin directory. You can then
 
     vendor/bin/guides ./docs
 
-The commandline tool is build for extension, if you do not have special needs this is the
+The commandline tool is built for extension, if you do not have special needs this is the
 recommended way to get started. You can learn more about how to extend the commandline tool in the :doc:`/cli/index` section.
 
 Library (advanced)
-===============================
+==================
 
 .. _library:
 

docs/reference/restructuredtext/admonitions.rst

@@ -7,7 +7,7 @@ Admonitions
 ===========
 
 Admonitions are blocks of text that are rendered in a special way to draw attention to them. They are often used to
-provide additional information to the reader about the content that is being discussed. t6est
+provide additional information to the reader about the content that is being discussed.
 
 .. index:: reST directives; seealso