Skip to content

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

@sypets

Description

@sypets

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions