TYPO3-Documentation · Alagts · Dec 12, 2023 · Jan 13, 2024 · Jan 13, 2024 · Jan 14, 2024
diff --git a/.editorconfig b/.editorconfig
@@ -21,3 +21,7 @@ trim_trailing_whitespace = true
 indent_style = space
 indent_size = 4
 max_line_length = 80
+
+[{Makefile,_Makefile}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,17 @@
+name: test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    name: documentation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Test if the documentation will render without warnings
+        run: |
+          mkdir -p Documentation-GENERATED-temp \
+          && docker run --rm --pull always -v $(pwd):/project \
+             ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -5,6 +5,15 @@ Contributing
 Information About Contributing to This Manual
 =============================================
 
+Local rendering
+---------------
+
+You can render this manual locally if you have `Docker <https://www.docker.com/>`
+and `make <https://www.gnu.org/software/make/>` installed on your local
+machine::
+
+    make docs
+
 Create Issues
 -------------
 
@@ -21,10 +30,10 @@ Make changes (create pull requests)
   `rendered page <https://docs.typo3.org/typo3cms/HowToDocument/Index.html>`__,
   just click on "Edit me on GitHub".
 * Step-by-step walkthrough of making a change by `Editing Directly on GitHub
-  <https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html>`__ 
+  <https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html>`__
   (this requires only a browser)
 * Step-by-step walkthrough of `Local Editing and Rendering with Docker
-  <https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html>`__ 
+  <https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html>`__
   (this requires knowledge of Git and Docker)
 
 * See `Writing Documentation <https://docs.typo3.org/typo3cms/HowToDocument/>`__ for further

diff --git a/Documentation/About.rst b/Documentation/About.rst
@@ -1,59 +1,21 @@
-.. include:: /Includes.rst.txt
-.. highlight:: rst
-.. _about:
+..  include:: /Includes.rst.txt
+..  highlight:: rst
+..  _about:
 
 ================
 About this guide
 ================
 
+This guide was written to help the reader to :ref:`contribute to the official TYPO3
+documentation <contribute>` and to :ref:`write documentation for their own
+extensions <writing-doc-for-ext-start>`.
 
-How this guide is structured
-============================
+Documentation written in :ref:`reStructured Text <rest-quick-start>` can be
+:ref:`rendered <rendering-docs>` using a TYPO3-specific theme and
+automatically deployed to
+https://docs.typo3.org  by adding a :ref:`Webhook <webhook>`.
 
-This manual covers writing TYPO3 documentation. This includes, contributing
-to official documentation, the core changelog and system extensions and
-writing documentation for third party extensions.
-
-It is more than just documentation: it also lists some conventions, coding
-guidelines and provides links to GitHub issues.
-
-
-.. index:: Writing documentation; Getting started
-.. _getting-started:
-.. _how-to-read-this-guide:
-
-How to read this guide
-======================
-
-This manual introduces you to writing TYPO3 documentation. You can read
-it cover-to-cover.
-
-.. tip::
-
-   Specifically, you might like to look at:
-
-   *  :ref:`basic-principles` to familiarize yourself with the structure
-   *  :ref:`conventions` for tips on coding guidelines, spelling etc.
-   *  :ref:`reStructuredText & Sphinx Introduction <writing-rest-introduction>`.
-   *  Additionally, keep the :ref:`rest-cheat-sheet` handy to look up the syntax.
-
-
-But often, you would like to **jump right in**, start with a specific task
-and learn as you go along. In that case, find your task here and start reading:
-
-*  :ref:`how-to-start-docs-extension` if you have an extension and would
-   like to write documentation for it using the sample extension manual.
-*  :ref:`docs-contribute-github-method` if you would like to contribute to
-   the official documentation and need an easy introduction to editing
-   documentation directly on GitHub. This does not require any development
-   tools, you just need a browser and a GitHub account.
-*  :ref:`docs-contribute-git-docker` if you would like to contribute to
-   the official documentation and are already familiar with Git and Docker
-*  :ref:`render-documenation-with-docker` if you would like to start with rendering the
-   documentation locally with Docker.
-
-
-.. _credits:
+..  _credits:
 
 Credits
 =======
@@ -64,14 +26,12 @@ Special thanks to Xavier Perseguers, who wrote some of the original texts
 in the retired TYPO3 Wiki and elsewhere. Some of the texts have been
 incorporated into this document or at least served as a basis.
 
-Further chapters like
-:ref:`rest-common-pitfalls`, :ref:`rest-cheat-sheet`, :ref:`docs-contribute`,
-:ref:`basic-principles`, :ref:`writing-doc-for-ext-start` and :ref:`docs-official-how-you-can-help`
-were added by Sybille Peters.
+Further chapters were added by Sybille Peters.
 
 A number of other people have helped by reviewing and refining the text
 and pointing out missing information. For more contributors, see the
-`list of contributors on GitHub for this manual <https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/graphs/contributors>`__.
+`list of contributors on GitHub for this manual
+<https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/graphs/contributors>`__.
 
 We thank everyone for their help and hope that good documentation
 about writing documentation will make it easier for others to contribute.
diff --git a/Documentation/Appendix/ExampleTocTree/Index.rst b/Documentation/Appendix/ExampleTocTree/Index.rst
diff --git a/Documentation/Appendix/ExampleTocTree/Topic1/Index.rst b/Documentation/Appendix/ExampleTocTree/Topic1/Index.rst
diff --git a/Documentation/Appendix/ExampleTocTree/Topic1/Subtopic1.rst b/Documentation/Appendix/ExampleTocTree/Topic1/Subtopic1.rst
diff --git a/Documentation/Appendix/ExampleTocTree/Topic1/Subtopic2.rst b/Documentation/Appendix/ExampleTocTree/Topic1/Subtopic2.rst
diff --git a/Documentation/Appendix/Index.rst b/Documentation/Appendix/Index.rst
diff --git a/Documentation/Appendix/ResourcesForEditors.rst b/Documentation/Appendix/ResourcesForEditors.rst
diff --git a/Documentation/BasicPrinciples.rst b/Documentation/BasicPrinciples.rst
@@ -119,8 +119,6 @@ learning, tutorials provide examples to illustrate the subjects they cover.
 They may not necessarily follow best-practices by the letter. They are
 designed to make it easier to get started.
 
-:ref:`Read more ... <writing-tutorial>`
-
 The definitions for tutorials, guides, explanations and references were taken from
 `Daniele Procida: What nobody tells you about documentation <https://www.divio.com/blog/documentation/>`__
 
@@ -135,8 +133,6 @@ A guide is a manual.
 
 Guides offer advice on **how best to achieve a given task**. They are goal oriented.
 
-:ref:`Read more ... <writing-guide>`
-
 
 .. index::  TYPO3 documentation; Reference
 .. _doc-type-reference:
@@ -312,13 +308,7 @@ Examples for system extensions are:
 *  `ext:rte_ckeditor <https://docs.typo3.org/typo3cms/extensions/rte_ckeditor/>`__
 
 Note, that if your system has been installed with Composer, not all system extensions may exist
-in the system, if each system extension has been required separately as "subtree splitted packages"
-(not as `typo3/cms`). Since TYPO3 9, installation of "subtree splitted packages" is mandatory.
-
-For more information on subtree split, see
-
-*  `Usetypo3: The TYPO3 Subtree Split and Composer <https://usetypo3.com/typo3-subtree-split-and-composer.html>`__
-*  :ref:`Installation and Upgrade guide: Composer migration <composer-migration-require-subtree-packages>`
+in the system.
 
 
 .. index:: pair: System extensions; Documentation

diff --git a/Documentation/Changes.rst b/Documentation/Changes.rst
diff --git a/Documentation/CodeSnippets/FileStructure/Dashboard/IncludesRstTxt.rst.txt b/Documentation/CodeSnippets/FileStructure/Dashboard/IncludesRstTxt.rst.txt