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

Support for 1-page extension manuals with zero configuration (single file README.rst or README.md)? #118

Open
sypets opened this issue Sep 17, 2021 · 1 comment
Assignees
Labels

Comments

@sypets
Copy link
Contributor

sypets commented Sep 17, 2021

Some extension authors have just a single file README.md or README.rst which is rendered on GitHub. While this is ok, the extension cannot be found via search on docs.typo3.org.

Instead of forcing everyone to create a Documentation folder, I think we might provide better support for the single-file solutions, so that extension authors do not have to change anything but will add the webhook to get their documentation rendered on docs.typo3.org.

This might even get more people to embrace .rst and find out that it is not so complicated (though .md is supported as well).

To acchieve this, I think the following would be helpful

  1. Create a default project title instead of "The Project's title" if the Settings.cfg is missing, e.g. use the package name
  2. Make sure "Edit on GitHub" generates a correct link, see migrate2composer example: if you click on "Edit on GitHub", it assumes the path to the README.rst is https://github.com/sypets/migrate2composer/edit/master/Documentation/README.rst
  3. Automatically create the correct setting for "Edit on GitHub" - if possible
  4. Do not display the title README
  5. ...

Take for example typo3-encore and render this locally:

image

You can also look at my extension migrate2composer which also uses a single README (but has a Documentation/Settings.cfg) as well:

https://docs.typo3.org/p/sypets/migrate2composer/master/en-us/Index.html

@sypets
Copy link
Contributor Author

sypets commented Sep 17, 2021

@marble marble self-assigned this Apr 6, 2022
@marble marble added the accepted label Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants