Board Thread:Watercooler/@comment-5590118-20150701035141/@comment-24473195-20150930091816

DarthKitty wrote:

. For those reasons, every module should be documented. Agreed.

In order to make documentation less redundant, only the following information is needed for ported modules:

I would add that the syntax for the module should also be included, and perhaps some examples.
 * An infobox with the usual links.
 * A short description, ideally copied from the original source.
 * The Lua parallel for Template:Script Install, once we write that.

Because every module will have a documentation page, we can no-longer overwrite the default "docs" link on Module:Luadocs. Instead, I suggest we use the module's name as a link to the original source when necessary. For example, the links for Module:List would look like this: http://i.imgur.com/QuDsepf.png I'm actually conflicted between using the module name as a link to the actual docs vs using the docs. Generally speaking most people would probably have the impulse of clicking the main link, instead of the docs, and it is likely they'd expect it to lead them to local documentation. But considering that external modules are currently the exception rather than the rule, I agree with your changes.

For this to work, we would have to remove the   and   args. Replacing them would be a new arg called , which would accept a URL and update the title accordingly. For more information, please see Module:Luadocs/sandbox.

Sure.

Do you think that would work, or is there something I overlooked?

EDIT: Maybe the "source" link should be changed back to "code" as well? At the very least, it would mesh with Template:Infobox Lua... We can automatically detect external Wikimedia/wikipedia links based on their url, and add the icon accordingly.

Also, there's something to be said about pure Lua modules like Module:inspect and Module:date. I think it would be nice make a note to them because unlike regular modules these can be added to wikimedia projects without any changes and can even be used by other Lua projects completely unrelated to MediaWiki. In fact, we should always strive to make pure lua modules whenever possible, and maybe even add them to github.

So we could also add icons relating to github whenever we detect their url. That will benefit us if someone improves it, just as we benefit from the improvements that their authors made.