Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Align with new TYPO3 documentation standards #2831

Merged
merged 4 commits into from
Apr 10, 2022
Merged

[TASK] Align with new TYPO3 documentation standards #2831

merged 4 commits into from
Apr 10, 2022

Conversation

alexander-nitsche
Copy link
Contributor

Hi Sebastian,

this PR is a suggestion to align your package documentation with the recently introduced TYPO3 documentation standards.

I mainly reworked some content, moved your documentation TOC to /docs, added some badges in README and additional sources (TER, repository and docs.typo3.org) in composer.json.

Greetings, Alex

Relates: TYPO3-Documentation/T3DocTeam#182
Relates: TYPO3-Documentation/T3DocTeam#185

Each TYPO3 package should show

- current release version
- total download rate
- monthly download rate

in badges.
….json

Add the common package destinations to composer.json. Packagist
displays them in a prominent place.
Provide specific documentation URL at
https://github.com/sabbelasichon/typo3-rector/tree/main/docs.

Align external links presentation with README files of similar
packages.
- Reduce amount of redundant external links.
- Add TYPO3 links.
- Move abstract of project to front.
@sabbelasichon
Copy link
Owner

@alexander-nitsche Thank you.
@helsner What do you think? You are the master of the documentation. Feel free to merge if you like.

@helsner
Copy link
Collaborator

helsner commented Apr 10, 2022

thanks for your effort - looks good and i'm fine with all of that but one thing:
You removed the sentence where it says that this repo is only for dev and not to clone.
In the past we often had issues with people trying typo3-rector directly and not using rector/rector, so i would like to keep that somehow.
This won't prevent people 100%, but at least we can say it's in the docs :D
Whats you opinion on that @sabbelasichon ?

@alexander-nitsche
Copy link
Contributor Author

Sure, adjust to your likes.

My explanation for the removal: I combined this hint with the mentioning of the parent Rector project:

It extends the Rector project, which aims to provide instant upgrades and instant refactoring for any PHP code (5.3+).

I would suggest to extend this sentence if you still want to be more precise on the Rector dependency here.

@helsner
Copy link
Collaborator

helsner commented Apr 10, 2022

Ah ok, i'll think about something, but other than that thank you very much for your big change!

@sabbelasichon sabbelasichon merged commit 5fc785d into sabbelasichon:main Apr 10, 2022
@sabbelasichon
Copy link
Owner

@alexander-nitsche @helsner Thanks both of you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants