Skip to content

[TASK] Bring the reST markup to the documented house style - #879

Merged
linawolf merged 1 commit into
mainfrom
task/fix-rest-indentation
Sep 14, 2026
Merged

linawolf merged 1 commit into
mainfrom
task/fix-rest-indentation

Conversation

@linawolf

Copy link
Copy Markdown
Member

The guide asks for .. note:: with two spaces after the dots and a
body one level deeper, and for a list marker padded so the item text
starts at four. 34 files here still use the older narrow form.

This is not a search and replace: three spaces is correct under a marker
written with one space, and a continuation line has to keep lining up
with where its item text begins. Each construct was moved as a whole —
marker, body and everything nested below it.

Literal content was left alone: a - opening a line inside a shell
command is not a bullet, and the indentation inside a code example is
not this commit's business.

The rendered output is unchanged. All 75 pages were rendered before and
after and compared byte for byte; they differ only in the build
timestamp.

Releases: main, 14.3, 13.4
Assisted-by: Claude Opus 5 noreply@anthropic.com
Signed-off-by: Lina Wolf

The guide asks for `..  note::` with two spaces after the dots and a
body one level deeper, and for a list marker padded so the item text
starts at four. 34 files here still use the older narrow form.

This is not a search and replace: three spaces is correct under a marker
written with one space, and a continuation line has to keep lining up
with where its item text begins. Each construct was moved as a whole —
marker, body and everything nested below it.

Literal content was left alone: a `-` opening a line inside a shell
command is not a bullet, and the indentation inside a code example is
not this commit's business.

The rendered output is unchanged. All 75 pages were rendered before and
after and compared byte for byte; they differ only in the build
timestamp.

Releases: main, 14.3, 13.4
Assisted-by: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Lina Wolf
@linawolf
linawolf merged commit e87454b into main Sep 14, 2026
8 checks passed
@linawolf
linawolf deleted the task/fix-rest-indentation branch September 14, 2026 08:11
@typo3-docs-backport-bot

Copy link
Copy Markdown

Backport failed for 13.4, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 13.4
git worktree add -d .worktree/backport-879-to-13.4 origin/13.4
cd .worktree/backport-879-to-13.4
git switch --create backport-879-to-13.4
git cherry-pick -x e87454b1744af98049ea9e7fac21c33cf0a8d191

@typo3-docs-backport-bot

Copy link
Copy Markdown

Successfully created backport PR for 14.3:

@typo3-docs-backport-bot

Copy link
Copy Markdown

Backport failed or needs manual intervention.

Backport action outcome: success
Backport success output: false
Per target: 13.4=false 14.3=true
Created backport PRs: 880

Workflow run: https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/actions/runs/34821422522

linawolf added a commit that referenced this pull request Sep 14, 2026
The guide asks for `..  note::` with two spaces after the dots and a
body one level deeper, and for a list marker padded so the item text
starts at four. 34 files here still use the older narrow form.

This is not a search and replace: three spaces is correct under a marker
written with one space, and a continuation line has to keep lining up
with where its item text begins. Each construct was moved as a whole —
marker, body and everything nested below it.

Literal content was left alone: a `-` opening a line inside a shell
command is not a bullet, and the indentation inside a code example is
not this commit's business.

The rendered output is unchanged. All 75 pages were rendered before and
after and compared byte for byte; they differ only in the build
timestamp.

Releases: main, 14.3, 13.4
Assisted-by: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Lina Wolf

Signed-off-by: Lina Wolf
(cherry picked from commit e87454b)

Signed-off-by: Lina Wolf
Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com>
linawolf added a commit that referenced this pull request Sep 14, 2026
The guide asks for `..  note::` with two spaces after the dots and a
body one level deeper, and for a list marker padded so the item text
starts at four. 33 files here still use the older narrow form.

This is not a search and replace: three spaces is correct under a marker
written with one space, and a continuation line has to keep lining up
with where its item text begins. Each construct was moved as a whole —
marker, body and everything nested below it.

Literal content was left alone: a `-` opening a line inside a shell
command is not a bullet, and the indentation inside a code example is
not this commit's business.

The automatic backport of #879 failed, so the same conversion was run
against this branch's own files.

The rendered output is unchanged. All 71 pages were rendered before and
after and compared byte for byte; they differ only in the build
timestamp.

Releases: main, 14.3, 13.4
Assisted-by: Claude Opus 5 <noreply@anthropic.com>
Signed-off-by: Lina Wolf

Signed-off-by: Lina Wolf
@linawolf linawolf added backport-done and removed backport-failed Backport failed or needs manual intervention labels Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant