Task #106856: Wrong format in README.md - TYPO3 Core - TYPO3 Forge

Custom queries

Accessibility
Easy tasks
Forge Triage
JavaScript issues
JavaScript Issues (w/o Epics/Stories)
My open issues
No feedback within 90 days
Open Bugs
Open issues of 10
Recently modified
Regressions
Stabilization Issues
Usability or UX

Watchers (1)

Garvin Hicking

Actions

Copy link

Task #106856

closed

Wrong format in README.md

Added by Stefan Froemken 10 days ago. Updated 9 days ago.

Status:

Resolved

Priority:

Must have

Assignee:

Category:

Documentation

Target version:

next-patchlevel

Start date:

2025-06-10

Due date:

% Done:

100%

Estimated time:

TYPO3 Version:

PHP Version:

8.3

Tags:

Complexity:

easy

Sprint Focus:

Description

Hello,

README.md is a markdown file and also should contain markdown. Currently, it contains ReStructured Text format.

Stefan

History
Notes
Property changes
Associated revisions

Actions

Copy link

Updated by Stefan Froemken 10 days ago

I just got the information that this is also valid and is an "alternative" way to declare headers.

With that new information I ask: Why we should the alternative way and not the default and more common way to declare headers?

Actions

Copy link

Updated by Garvin Hicking 9 days ago

Tracker changed from Bug to Task
Status changed from New to Needs Feedback

I think we could definitely switch to "usual" markdown headers. Subheaders in "TYPO3 resources" are already in markdown format, and we should IMO align this.

Would you like to propose a patch for this? You'd have my vote :)

(Should be a 'task' and not a 'bug' then, switched the issue)

Actions

Copy link

Updated by Gerrit Code Review 9 days ago

Status changed from Needs Feedback to Under Review

Patch set 1 for branch main of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/89690

Actions

Copy link

Updated by Gerrit Code Review 9 days ago

Patch set 2 for branch main of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/89690

Actions

Copy link

Updated by Gerrit Code Review 9 days ago

Patch set 1 for branch 13.4 of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/89696

Actions

Copy link