Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com>
  • Loading branch information
linawolf and brotkrueml authored Jan 14, 2024
1 parent 6d181ad commit 4b2c3d6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions Documentation/GeneralConventions/GuidesXml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ This XML file contains meta information and configuration used during rendering
of a manual.

.. hint::
If you are migrating from the legacy Sphinx based rendering and still have
a :file:`Documentation/settings.cfg` you can use an automatic migration
If you are migrating from the legacy Sphinx-based rendering and still have
a :file:`Documentation/Settings.cfg` you can use an automatic migration
tool to :ref:`migrate the settings.cfg into a guides.xml <migrate_guides_xml>

.. _settings-guides:

The `<guides>` tag
==================

Is used for configuration during parsing and rendering. Most available settings
It is used for configuration during parsing and rendering. Most available settings
are predefined in the rendering chain supplied by the
:ref:`TYPO3 Rendering Container <rendering-docs>`.

Expand All @@ -32,7 +32,7 @@ Project title
-------------

The *project* property contains the title of the project and is displayed in the
left sidebar (desktop) or the top (mobile) of the theme and in the title meta
left sidebar (desktop) or the top (mobile) of the theme and in the title
tag.

For TYPO3 extensions we suggest to use the extension name in a readable
Expand Down Expand Up @@ -63,7 +63,7 @@ and mostly correspond to the version of the TYPO3 LTS or TYPO3 extension to
which the documentation refers.

The version is shown below the title in the theme's release switch and in the
title meta tag, the release is not shown currently - but it should be
title tag, the release is not shown currently - but it should be
kept anyway to satisfy internal requirements.

Normally both properties are set to the same value, either
Expand Down
4 changes: 2 additions & 2 deletions Documentation/GeneralConventions/ReadmeFile.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Remove this field if the project is no extension or package.
.. _readme-rst-project:

Project
^^^^^^^
=======

The *project* placeholder contains the title of the project.

Expand All @@ -85,7 +85,7 @@ and in TYPO3 system and third-party extensions
.. _readme-rst-abstract:

Abstract
^^^^^^^^
========

The *abstract* placeholder contains a short and precise description of the
project with as many keywords as possible in as few sentences as possible. It
Expand Down

0 comments on commit 4b2c3d6

Please sign in to comment.