Page MenuHomePhabricator

remove wiki documentation that duplicates generated documentation (tracking)
Open, Needs TriagePublic

Description

In T91626#1102477 @Krinkle wrote

Documentation about modules, classes, methods, configuration variables, apis, hooks etc. always have their wiki equivalent either missing, outdated or wrong. This is natural and unavoidable because developers are not required to maintain these pages. And maintenance is also hard as it would have to happen after review/merge of the commit. These pages can be deleted and the new interface can use the relevant data directly.

I've started doing this for APIs in T89318: Replace on-wiki API documentation with Special:ApiHelp transclusion, I'll create similar tasks for the others. For some of these, we need to create "the new interface" e.g. generate hooks documentation.

Note that editors on mediawiki.org try to document multiple releases in one place, including the changes to and deprecations of the defaults and parameters of "modules, classes, methods, configuration variables, apis, hooks, etc.". Generated doc tends to only reflects the latest code it ran against, unless we do a fair amount of work. See concerns in T90528: Generated API Help doesn't indicate the MediaWiki versions that support a module and parameters..

Event Timeline

Spage raised the priority of this task from to Needs Triage.
Spage updated the task description. (Show Details)
Spage added a project: Documentation.
Spage added subscribers: Spage, Krinkle.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 17 2015, 11:39 PM
Spage updated the task description. (Show Details)Mar 20 2015, 4:29 AM
Spage set Security to None.
jayvdb added a subscriber: jayvdb.Mar 20 2015, 4:43 AM
Ricordisamoa added a subscriber: Ricordisamoa.