Talk:Community Wishlist/Wishes/Document ALL the modules!
Add topicThis page is for discussions related to the Community Wishlist/Wishes/Document ALL the modules! page.
Please remember to:
|
|
Scope
[edit]The modules themselves are written by communities so I doubt WMF can or should document them. That said, providing an infrastructure that facilitates the documentation of modules (e.g. autogenerating pages to put documentation on for each function) can be within the scope of the wishlist. Nardog (talk) 06:31, 26 August 2024 (UTC)
- I second with this. I'd support an auto generator, but I don't think it's in WMF scope to document modules on hundreds of wikis. A09|(pogovor) 20:55, 26 August 2024 (UTC)
@Duckmather: Thanks for creating this wish. The existing module documentation mechanism is to transclude any /doc subpage (e.g. wikipedia:Module:Message box/doc) to show above the module code. Perhaps you could add more info about why this is not sufficient? Note also that the actual writing of documentation of modules is likely out of scope for the Wishlist (unless a module is created while fulfilling some other wish). SWilson (WMF) (talk) 23:50, 26 August 2024 (UTC)
- @Nardog, A09, and SWilson (WMF): If I were to propose a specific technical way to fix this problem, it would be a tool, or maybe a MediaWiki extension, called "ModuleData" (analogous to the existing "TemplateData" tool). This would furnish structured, machine-readable data about each module, right on its documentation page, just as TemplateData furnishes structured, machine-readable data about each template, right on its documentation page. But Community Wishlist#How to write a good wish explicitly states that I should write the wish in such a way as to articulate a problem they face without providing an explicit solution (i.e. framing the wish as a problem, rather than as a solution), so I wrote my wish the way I did. Duckmather (talk) 03:02, 27 August 2024 (UTC)