Page MenuHomePhabricator
Create Task
Maniphest T424194

Improve jsdoc for WikiEditor and publish to docs.wikimedia.org
Open, Needs TriagePublic
Actions

Description

This is a pretty common extension that lots of parties interact with. It's probably a good idea to get its documentation properly published.

Extension description and repo location: https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:WikiEditor

Some documentation exists at:
https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:WikiEditor/Toolbar_customization
https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:WikiEditor/Toolbar_customization/Library

CodeMirror is an existing extension that has JSDoc that is being published.
https://gerrit.wikimedia.org/g/mediawiki/extensions/CodeMirror

Instructions for JSDoc are at:
https://www.mediawiki.org/wiki/JSDoc

This includes publishing instructions:
https://www.mediawiki.org/wiki/JSDoc#4._Publish_on_doc.wikimedia.org
After setting up publishing, it would then end up at https://doc.wikimedia.org in the MediaWiki Components section

Details

Related Changes in Gerrit:
SubjectRepoBranchLines +/-
docs: add JSDoc for buildRow function in toolbar modulemediawiki/extensions/WikiEditormaster+9 -0
Improve JSDoc for toolbar module functionsmediawiki/extensions/WikiEditormaster+172 -0
Improve JSDoc for WikiEditor functionsmediawiki/extensions/WikiEditormaster+144 -121
Improve JSDoc descriptions in realtimepreview modulemediawiki/extensions/WikiEditormaster+46 -10
Customize query in gerrit

Event Timeline

TheDJ created this task.Apr 23 2026, 9:13 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 23 2026, 9:13 AM

Thank you for tagging this task with good first task for Wikimedia newcomers!

Newcomers often may not be aware of things that may seem obvious to seasoned contributors, so please take a moment to reflect on how this task might look to somebody who has never contributed to Wikimedia projects.

A good first task is a self-contained, non-controversial task with a clear approach. It should be well-described with pointers to help a completely new contributor, for example it should clearly point to the codebase URL and provide clear steps to help a contributor get set up for success. We've included some guidelines at https://phabricator.wikimedia.org/tag/good_first_task/ !

Thank you for helping us drive new contributions to our projects <3

TheDJ updated the task description. (Show Details)Apr 23 2026, 9:14 AM
TheDJ updated the task description. (Show Details)
Jack_who_built_the_house subscribed.Apr 23 2026, 9:21 PM
Status-401 subscribed.Apr 28 2026, 7:57 AM

Hi, I’d like to work on this task.

Plan:

  • Add JSDoc comments to core WikiEditor modules
  • Set up JSDoc configuration
  • Generate documentation locally
  • Follow CodeMirror extension as reference
  • Attempt publishing setup for doc.wikimedia.org

Please let me know if there are specific modules to prioritize.

TheDJ added a comment.Apr 28 2026, 9:53 AM

@Status-401 there are no specific priorities, but I'd like to point out that there are a few in progress patches related to this:

https://gerrit.wikimedia.org/r/q/project:mediawiki/extensions/WikiEditor+status:open

Specifically:
https://gerrit.wikimedia.org/r/c/mediawiki/extensions/WikiEditor/+/1277259
https://gerrit.wikimedia.org/r/c/mediawiki/extensions/WikiEditor/+/1276668

gerritbot added a comment.Apr 28 2026, 9:53 AM

Change #1277259 had a related patch set uploaded (by TheDJ; author: Praveen5638):

[mediawiki/extensions/WikiEditor@master] Improve JSDoc for WikiEditor functions

https://gerrit.wikimedia.org/r/1277259

gerritbot added a project: Patch-For-Review.Apr 28 2026, 9:53 AM

Change #1276668 had a related patch set uploaded (by TheDJ; author: Mohdsarfraz):

[mediawiki/extensions/WikiEditor@master] Improve JSDoc formatting (align comment with function)

https://gerrit.wikimedia.org/r/1276668

gerritbot added a comment.Apr 28 2026, 11:58 AM

Change #1278419 had a related patch set uploaded (by Status 401; author: Status 401):

[mediawiki/extensions/WikiEditor@master] Improve JSDoc for toolbar module functions

https://gerrit.wikimedia.org/r/1278419

Status-401 added a comment.Apr 28 2026, 12:02 PM

Submitted patch 1278419 — adds JSDoc blocks for the 19 previously-undocumented functions in jquery.wikiEditor.toolbar.js (the api.* and fn.* objects). Verified locally with npm run doc under pedantic: true and eslint. Targeted functions don't overlap with the in-progress patches 1276668 and 1277259. Will follow up with the integration/config and integration/docroot patches to set up CI publishing once the JSDoc patches land.

gerritbot added a comment.Apr 28 2026, 12:48 PM

Change #1278439 had a related patch set uploaded (by Status 401; author: Status 401):

[mediawiki/extensions/WikiEditor@master] Improve JSDoc descriptions in realtimepreview module

https://gerrit.wikimedia.org/r/1278439

gerritbot added a comment.May 2 2026, 8:33 AM

Change #1281645 had a related patch set uploaded (by TheDJ; author: Shauryasingh0302):

[mediawiki/extensions/WikiEditor@master] docs: add JSDoc for buildRow function in toolbar module

https://gerrit.wikimedia.org/r/1281645

gerritbot added a comment.May 2 2026, 9:55 AM

Change #1278439 merged by jenkins-bot:

[mediawiki/extensions/WikiEditor@master] Improve JSDoc descriptions in realtimepreview module

https://gerrit.wikimedia.org/r/1278439

ReleaseTaggerBot added a project: MW-1.47-notes (1.47.0-wmf.1; 2026-05-05).May 2 2026, 10:00 AM
happy5214 subscribed.Fri, May 15, 5:34 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits