Skip to content

Improve documentation with findings from onsite sprint#2008

Open
Starkmann wants to merge 11 commits intomainfrom
feature/2006-documentation-improvment
Open

Improve documentation with findings from onsite sprint#2008
Starkmann wants to merge 11 commits intomainfrom
feature/2006-documentation-improvment

Conversation

@Starkmann
Copy link
Contributor

@Starkmann Starkmann commented Mar 26, 2026

Related: #2006

@coveralls
Copy link

coveralls commented Mar 26, 2026

Pull Request Test Coverage Report for Build 23605894347

Warning: 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

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 23337769227: 0.0%
Covered Lines: 111
Relevant Lines: 111

💛 - Coveralls

@Starkmann Starkmann changed the title Impprome documentation with findings in onsite sprint Improve documentation with findings in onsite sprint Mar 26, 2026
@Starkmann Starkmann changed the title Improve documentation with findings in onsite sprint Improve documentation with findings from onsite sprint Mar 26, 2026
Starkmann and others added 5 commits March 26, 2026 15:45
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>
Starkmann and others added 2 commits March 26, 2026 16:27
Co-authored-by: Daniel Siepmann <coding@daniel-siepmann.de>
Co-authored-by: Daniel Siepmann <coding@daniel-siepmann.de>
@DanielSiepmann DanielSiepmann moved this from In Progress to In Review in Best Practices Remote Day/Sprint Mar 26, 2026
https://github.com/oliverklee-de/TYPO3-testing-distribution/blob/13.x/README.md (TYPO3 13)
Adjust link to your needed version.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop the second blank line.

Suggested change


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-project-automation github-project-automation bot moved this from In Review to In Progress in Best Practices Remote Day/Sprint Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

5 participants