From f6a28c3b92001f6bb034504b3d8b1c5e5f1f23ee Mon Sep 17 00:00:00 2001 From: Franz Holzinger Date: Sat, 3 Jan 2026 18:39:21 +0100 Subject: [PATCH 1/2] Fix typos and improve clarity in documentation WritingDocForExtension misspelling, rewording --- Documentation/Howto/WritingDocForExtension/Index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/Howto/WritingDocForExtension/Index.rst b/Documentation/Howto/WritingDocForExtension/Index.rst index 6e689539..e49871da 100644 --- a/Documentation/Howto/WritingDocForExtension/Index.rst +++ b/Documentation/Howto/WritingDocForExtension/Index.rst @@ -24,14 +24,14 @@ Use the following Docker command to render your documentation guide locally: .. include:: /_Includes/_LocalRendering.rst.txt -The :ref:`render-documentation-with-docker` has more information. +See :ref:`render-documentation-with-docker` for more information. .. _how-to-start-docs-extension: Use the init command to create the Documentation folder ======================================================= -The following Docker command helps you to create some basic documentation +The following Docker command creates some basic documentation including the required configuration file :file:`Documentation/guides.xml`: .. include:: /_Includes/_InitCommand.rst.txt @@ -40,7 +40,7 @@ The command creates a folder :path:`Documentation` in the directory it is called from. This should be the root directory of your extension containing the `composer.json `_. -Follow the interactive dialoge. We suggest to use the option ReStructuredText (rst) +Follow the interactive dialog. We suggest to use the option ReStructuredText (rst) as this format provides the full power of the TYPO3 documentation theme. Using Markdown (md) is an option for simple and quick one page documentation. @@ -48,7 +48,7 @@ If your extension offers a main `Site set ` the new documentation. From 47cdcd7a511610ffc90ac2b0421496d7aaed19ea Mon Sep 17 00:00:00 2001 From: Franz Holzinger Date: Sat, 3 Jan 2026 18:42:41 +0100 Subject: [PATCH 2/2] Fix caption grammar in _InitCommand.rst.txt It is the second case which needs the apostrophe. --- Documentation/_Includes/_InitCommand.rst.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/_Includes/_InitCommand.rst.txt b/Documentation/_Includes/_InitCommand.rst.txt index cd2926c7..81af67c9 100644 --- a/Documentation/_Includes/_InitCommand.rst.txt +++ b/Documentation/_Includes/_InitCommand.rst.txt @@ -1,4 +1,4 @@ .. code-block:: bash - :caption: Execute in extension root, the directory that contains your extensions composer.json + :caption: Execute in extension root, the directory that contains your extension's composer.json docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest init