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

VCS README example - point out .rst format. #293

Open
sypets opened this issue Aug 8, 2022 · 0 comments
Open

VCS README example - point out .rst format. #293

sypets opened this issue Aug 8, 2022 · 0 comments

Comments

@sypets
Copy link
Contributor

sypets commented Aug 8, 2022

https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/UserRoundTrip.html#vcs-repository

Example README for VCS repository: please point out what format this is (.rst or .md). It is possible to find this out but I think it should be stated more explicitly. People are not always aware of the distinction and even not aware that you can use .rst (and not .md) as README on GitHub / Gitlab etc.

Also, optionally also offer a Markdown example. Some (many) extension authors use Markdown as README and will/may not change this.

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

No branches or pull requests

1 participant