[TASK] Move advanced topics from basic to advanced

TYPO3-Documentation · Nov 22, 2024 · 3fc6da1 · 3fc6da1
1 parent b722bb0
commit 3fc6da1
Show file tree

Hide file tree

Showing 26 changed files with 39 additions and 557 deletions.
diff --git a/...s/GeneralConventions/CodingGuidelines.rst → Documentation/Advanced/CodingGuidelines.rst b/...s/GeneralConventions/CodingGuidelines.rst → Documentation/Advanced/CodingGuidelines.rst
@@ -194,7 +194,6 @@ file:
    reST directives; deprecated
    reST directives; versionadded
    reST directives; versionchanged
-.. _version-hints:
 
 How to add version hints
 ========================

diff --git a/.../GeneralConventions/ContentStyleGuide.rst → Documentation/Advanced/ContentStyleGuide.rst b/.../GeneralConventions/ContentStyleGuide.rst → Documentation/Advanced/ContentStyleGuide.rst
@@ -7,6 +7,26 @@
 Spelling
 ========
 
+..  contents::
+
+Title capitalization
+====================
+
+Use :ref:`sentence case <spelling-title-case>` - this means the title and
+headers will be capitalized like normal sentences. The first word
+is always capitalized and the rest is spelled as they would in
+"normal text".
+
+This is different from "TYPO3 content style guide" which capitalizes
+more words in the title. Capitalization in the documentation is still
+inconsistent currently, so you cannot rely on existing pages to show
+the correct convention.
+
+Spelling
+========
+
+Use common spelling for American English. Some specific TYPO3 terms
+have a special spelling. See :ref:`spelling-ref`
 
 General information
 ===================

diff --git a/...tion/Basics/GeneralConventions/Format.rst → Documentation/Advanced/Format.rst b/...tion/Basics/GeneralConventions/Format.rst → Documentation/Advanced/Format.rst
diff --git a/...on/Basics/GeneralConventions/Glossary.rst → Documentation/Advanced/Glossary.rst b/...on/Basics/GeneralConventions/Glossary.rst → Documentation/Advanced/Glossary.rst
diff --git a/...eneralConventions/GuidelinesForImages.rst → ...entation/Advanced/GuidelinesForImages.rst b/...eneralConventions/GuidelinesForImages.rst → ...entation/Advanced/GuidelinesForImages.rst
diff --git a/...on/Advanced/HowToAddTranslation/Index.rst → ...entation/Advanced/HowToAddTranslation.rst b/...on/Advanced/HowToAddTranslation/Index.rst → ...entation/Advanced/HowToAddTranslation.rst
diff --git a/Documentation/Advanced/Index.rst b/Documentation/Advanced/Index.rst
@@ -0,0 +1,13 @@
+:navigation-title: Advanced
+.. include:: /Includes.rst.txt
+..  _advanced:
+
+=============================
+Advanced documentation topics
+=============================
+
+..  toctree::
+    :glob:
+    :titlesonly:
+
+    *
diff --git a/...on/Basics/GeneralConventions/Licenses.rst → Documentation/Advanced/Licenses.rst b/...on/Basics/GeneralConventions/Licenses.rst → Documentation/Advanced/Licenses.rst
diff --git a/.../Basics/GeneralConventions/ReadmeFile.rst → Documentation/Advanced/ReadmeFile.rst b/.../Basics/GeneralConventions/ReadmeFile.rst → Documentation/Advanced/ReadmeFile.rst
diff --git a/Documentation/Advanced/ReviewInformation.rst b/Documentation/Advanced/ReviewInformation.rst
diff --git a/...asics/GeneralConventions/ReviewPolicy.rst → Documentation/Advanced/ReviewPolicy.rst b/...asics/GeneralConventions/ReviewPolicy.rst → Documentation/Advanced/ReviewPolicy.rst
diff --git a/...GeneralConventions/images/backend-raw.png → ...mentation/Advanced/images/backend-raw.png b/...GeneralConventions/images/backend-raw.png → ...mentation/Advanced/images/backend-raw.png
diff --git a/...nventions/images/backend-with-boxes-2.svg → .../Advanced/images/backend-with-boxes-2.svg b/...nventions/images/backend-with-boxes-2.svg → .../Advanced/images/backend-with-boxes-2.svg
diff --git a/...Conventions/images/backend-with-boxes.png → ...on/Advanced/images/backend-with-boxes.png b/...Conventions/images/backend-with-boxes.png → ...on/Advanced/images/backend-with-boxes.png
diff --git a/...ons/images/github-getting-started-raw.png → ...ced/images/github-getting-started-raw.png b/...ons/images/github-getting-started-raw.png → ...ced/images/github-getting-started-raw.png
diff --git a/Documentation/Basics/BasicPrinciples.rst b/Documentation/Basics/BasicPrinciples.rst
@@ -55,8 +55,8 @@ All of these examples have a few things in common:
 *  The source of the documentation is written (mostly) in reStructuredText (**reST**)
 *  All documentation is rendered using the **same rendering toolchain**. All documentation
    can be rendered locally, with the officially supported Docker image.
-*  The documentation source files adhere to :ref:`general-conventions` and
-   share a **common structure** (for example all documentation files in a
+*  The documentation source files adhere to :ref:`file-structure`
+   (for example all documentation files in a
    :file:`Documentation` subdirectory).
 *  Due to the conventions, the rendering of documentation can be automated and
    every documentation project only requires a minimum of setup.

diff --git a/Documentation/Basics/GeneralConventions/Index.rst b/Documentation/Basics/GeneralConventions/Index.rst
diff --git a/Documentation/Howto/Contribute/HowYouCanHelp.rst b/Documentation/Howto/Contribute/HowYouCanHelp.rst
@@ -146,9 +146,6 @@ Here are some examples:
 Replace outdated images and screenshots
 =======================================
 
-Replace outdated images, for example, in the :ref:`t3tsconfig:start`
-reference.
-
 Look at :ref:`how-to-document-images` for information about how to
 embed images with reST.
 
@@ -170,8 +167,6 @@ Pick a manual and start reviewing it. If you find something that needs fixing or
 something is missing, either fix it or write an issue for it, if you cannot make
 the changes yourself.
 
-More information: :ref:`guidelines-for-reviewing`
-
 ..  tip::
     Usually, there is one branch for each major TYPO3 version
     in a manual. Please focus your efforts mostly on the "main" branch, to get

diff --git a/Documentation/Howto/Contribute/Index.rst b/Documentation/Howto/Contribute/Index.rst
@@ -13,7 +13,7 @@ Contribute to the TYPO3 documentation
 .. sidebar:: Quicklinks
 
    * :ref:`reStructuredText cheatsheet <rest-cheat-sheet>`
-   * :ref:`Conventions <conventions>`
+   * :ref:`File structure <file-structure>`
    * :ref:`Render with Docker <rendering-docs>`
    * :ref:`Typical tasks <docs-official-how-you-can-help>`
    * `Open issues <https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%3ATYPO3-Documentation>`__ (a GitHub account is required)

diff --git a/Documentation/Howto/WritingDocForExtension/Index.rst b/Documentation/Howto/WritingDocForExtension/Index.rst
@@ -14,8 +14,7 @@ How to document an extension
 This chapter explains how to write documentation for a new extension.
 
 This guide uses the `example extension manual <https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual>`__
-as a template for starting out. It contains a working navigation panel, a range of example content and adheres to the guidelines
-laid out in the :ref:`general-conventions` chapter.
+as a template for starting out.
 
 Rendering the documentation locally
 -----------------------------------

diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -94,7 +94,6 @@ reStructuredText (reST).
     Basics/About
     Basics/HowToGetHelp
     Basics/BasicPrinciples
-    Basics/GeneralConventions/Index
     Basics/RstCheatSheet
 
 
@@ -117,8 +116,7 @@ reStructuredText (reST).
     :hidden:
     :caption: ADVANCED
 
-    Advanced/HowToAddTranslation/Index
-    Advanced/ReviewInformation
+    Advanced/Index
 
 ..  toctree::
     :hidden: