Skip to content

Commit cc815d5

Browse files
authored
WritingDocForExtension: Fix typos and improve clarity (#504)
1 parent f7522b3 commit cc815d5

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Documentation/Howto/WritingDocForExtension/Index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Use the following Docker command to render your documentation guide locally:
2424

2525
.. include:: /_Includes/_LocalRendering.rst.txt
2626

27-
The :ref:`render-documentation-with-docker` has more information.
27+
See :ref:`render-documentation-with-docker` for more information.
2828

2929
.. _how-to-start-docs-extension:
3030

3131
Use the init command to create the Documentation folder
3232
=======================================================
3333

34-
The following Docker command helps you to create some basic documentation
34+
The following Docker command creates some basic documentation
3535
including the required configuration file :file:`Documentation/guides.xml`:
3636

3737
.. include:: /_Includes/_InitCommand.rst.txt
@@ -40,15 +40,15 @@ The command creates a folder :path:`Documentation` in the directory it is called
4040
from. This should be the root directory of your extension containing the
4141
`composer.json <https://docs.typo3.org/permalink/t3coreapi:files-composer-json>`_.
4242

43-
Follow the interactive dialoge. We suggest to use the option ReStructuredText (rst)
43+
Follow the interactive dialog. We suggest to use the option ReStructuredText (rst)
4444
as this format provides the full power of the TYPO3 documentation theme. Using
4545
Markdown (md) is an option for simple and quick one page documentation.
4646

4747
If your extension offers a main `Site set <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_
4848
enter its name and path when prompted. This will regenerate ready to use
4949
documentation about configuration for you. If you have more then one set you
5050
can document the other sets manually. If you have no set, you need to write
51-
the chapter your self.
51+
the chapter yourself.
5252

5353
Make changes and try :ref:`rendering <rendering-docs>` the new documentation.
5454

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.. code-block:: bash
2-
:caption: Execute in extension root, the directory that contains your extensions composer.json
2+
:caption: Execute in extension root, the directory that contains your extension's composer.json
33
44
docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest init

0 commit comments

Comments
 (0)