[TASK] Remove "common pitfalls"

Displaying wrong syntax in order to teach someone is generally not considered best practise. Also some of these are specific to sphinx or outdated spinx versions.
TYPO3-Documentation · Jan 30, 2024 · 22c63ea · 22c63ea
1 parent 88e247c
commit 22c63ea
Show file tree

Hide file tree

Showing 11 changed files with 4 additions and 412 deletions.
diff --git a/Documentation/GeneralConventions/Format.rst b/Documentation/GeneralConventions/Format.rst
@@ -88,7 +88,6 @@ readthedocs::
 
    *  indenting is important
    *  new lines are important, for example before, after and between bullet lists
-   *  more, see :ref:`rest-common-pitfalls`
 
 *  some people simply hate it
 

diff --git a/Documentation/WritingDocForExtension/Migrate.rst b/Documentation/WritingDocForExtension/Migrate.rst
@@ -51,9 +51,6 @@ Use our Docker container to render your documentation locally. Read more about
 Improve your documentation to render without warning
 ====================================================
 
-Have a look at :ref:`Common pitfalls <rest-common-pitfalls>` that might cause
-rendering warnings.
-
 If you believe you found a bug in the new PHP-based rendering, please open
 an `Issue on GitHub <https://github.com/TYPO3-Documentation/render-guides/issues>`__.
 

diff --git a/Documentation/WritingReST/CommonPitfalls/Headers.rst b/Documentation/WritingReST/CommonPitfalls/Headers.rst
diff --git a/Documentation/WritingReST/CommonPitfalls/Hyperlinks.rst b/Documentation/WritingReST/CommonPitfalls/Hyperlinks.rst
diff --git a/Documentation/WritingReST/CommonPitfalls/Indents.rst b/Documentation/WritingReST/CommonPitfalls/Indents.rst
diff --git a/Documentation/WritingReST/CommonPitfalls/Index.rst b/Documentation/WritingReST/CommonPitfalls/Index.rst
diff --git a/Documentation/WritingReST/CommonPitfalls/InlineStyle.rst b/Documentation/WritingReST/CommonPitfalls/InlineStyle.rst
diff --git a/Documentation/WritingReST/CommonPitfalls/Lists.rst b/Documentation/WritingReST/CommonPitfalls/Lists.rst
diff --git a/Documentation/WritingReST/Index.rst b/Documentation/WritingReST/Index.rst
@@ -20,9 +20,6 @@ It is recommended to read (or at least browse through)
 the :ref:`writing-rest-introduction` and the general
 :ref:`format-rest-cgl` first.
 
-Also read :ref:`rest-common-pitfalls` in order to avoid common
-mistakes with the syntax.
-
 You don't need to read the entire chapter, just lookup
 the section that is relevant for what you plan to do.
 
@@ -48,6 +45,5 @@ http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_
 
    Introduction
    BasicRestSyntax
-   CommonPitfalls/Index
    CheatSheet
    Reference/Index
diff --git a/Documentation/WritingReST/Reference/Content/BoldItalic.rst b/Documentation/WritingReST/Reference/Content/BoldItalic.rst
@@ -35,14 +35,8 @@ How it looks:
 
 This is normal text. *This is italic text.*
 
-
-Possible Errors
-===============
-
-..  important::
-
-    Make sure there is no space between the markup and the styled text,
-    see :ref:`common-pitfalls-inline-style`.
+..  hint::
+    Make sure there is no space between the markup and the styled text.
 
 
 Additional Information