Topic on Talk:Requests for comment/Documentation overhaul

I would suggest splitting all the documentation at ResourceLoader/Default modules into separate pages for each module. That way the module documentation will be more searchable and linkable. We could then replace ResourceLoader/Default modules with something like ResourceLoader/Default modules (draft). Kaldari (talk) 17:39, 17 September 2012 (UTC)

• What is and isn't auto-loaded must not be documented and is not to be relied on. It isn't relevant to anything, and if it, there's something very wrong with the relevant code.
• Wherever it will go, let it be in the Manual namespace
• Make sure we have a consistent page model for each (much like we have consistency for pages of API modules, Database tables and configuration variables).

One interesting point is whether to split up pages by module or by root-level object?

• mw.config and mw.html are not modules, they are part of mediawiki.
• mediawiki.api.edit extends mw.Api.prototype
• $.escapeRE and $.compareObject are both defined in jquery.mwExtension

I propose to document them per module, especially for jQuery plugins that is probably better. That way related code paths are documented on the same page (for they are defined in the same closure, so they have a lot in common already).