Improve documentation with findings from onsite sprint#2008
Open
Improve documentation with findings from onsite sprint#2008
Conversation
Pull Request Test Coverage Report for Build 23605894347Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
oliverklee
requested changes
Mar 26, 2026
Co-authored-by: Oliver Klee <typo3-coding@oliverklee.de>
Co-authored-by: Oliver Klee <typo3-coding@oliverklee.de>
Co-authored-by: Oliver Klee <typo3-coding@oliverklee.de>
Co-authored-by: Daniel Siepmann <coding@daniel-siepmann.de>
Co-authored-by: Daniel Siepmann <coding@daniel-siepmann.de>
DanielSiepmann
approved these changes
Mar 26, 2026
oliverklee
requested changes
Mar 26, 2026
| https://github.com/oliverklee-de/TYPO3-testing-distribution/blob/13.x/README.md (TYPO3 13) | ||
| Adjust link to your needed version. | ||
|
|
||
|
|
Contributor
There was a problem hiding this comment.
Let's drop the second blank line.
Suggested change
Documentation/Introduction.rst
Outdated
|
|
||
| Good extension names cover the domain of their purpose. | ||
| This extension is about managing teas. That's why the name "tea" is a good fit. | ||
| This extension tries to cover all fundamental aspects of the development of an extbase-extension. |
Contributor
There was a problem hiding this comment.
Suggested change
| This extension tries to cover all fundamental aspects of the development of an extbase-extension. | |
| This extension tries to cover all fundamental aspects of the development of an Extbase extension. |
Documentation/Introduction.rst
Outdated
| This extension is about managing teas. That's why the name "tea" is a good fit. | ||
| This extension tries to cover all fundamental aspects of the development of an extbase-extension. | ||
| The fictional use case here is the management of tea varieties. | ||
| The needed models, classes, controllers, etc. cover all typical parts of an extbase-extension. |
Contributor
There was a problem hiding this comment.
Suggested change
| The needed models, classes, controllers, etc. cover all typical parts of an extbase-extension. | |
| The needed models, classes, controllers, etc. cover all typical parts of an Extbase extension. |
Documentation/Introduction.rst
Outdated
| The target group of this extension are TYPO3-extension developers. Typical usecases are: | ||
|
|
||
| - getting inspired by looking into the code | ||
| - installing the tea-extension alongside another extension that gets developed and have a running test environment available. |
Contributor
There was a problem hiding this comment.
Suggested change
| - installing the tea-extension alongside another extension that gets developed and have a running test environment available. | |
| - installing the tea extension alongside another extension that gets developed and have a running test environment available. |
…PO3BestPractices/tea into feature/2006-documentation-improvment
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related: #2006