Page MenuHomePhabricator
Create Task
Maniphest T346157

Documentation for VisualEditor internals
Closed, ResolvedPublic
Actions

Description

Document the internal workings of the VisualEditor source code on MediaWiki.org, at an appropriate level of detail for onboarding an engineer unfamiliar with VisualEditor, providing pointers and explanations so they can self-familiarize with the source code.

Entry points:

https://www.mediawiki.org/wiki/VisualEditor/Internals
https://www.mediawiki.org/wiki/VisualEditor/Internals/DM
https://www.mediawiki.org/wiki/VisualEditor/Internals/CE
https://www.mediawiki.org/wiki/VisualEditor/Internals/UI

Existing pages that are also relevant (but may need updating):

https://www.mediawiki.org/wiki/VisualEditor/Developers/Getting_started
https://www.mediawiki.org/wiki/VisualEditor/Design/Software_overview
https://www.mediawiki.org/wiki/VisualEditor/Design#Historical_pages_(not_current)
https://www.mediawiki.org/wiki/VisualEditor/Presentations

Related Objects
Search...

Event Timeline

dchan created this task.Sep 12 2023, 2:52 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 12 2023, 2:52 PM
VPuffetMichel added a project: Editing-team (Kanban Board).Oct 19 2023, 3:34 PM
VPuffetMichel edited projects, added Editing-team; removed Editing-team (Kanban Board).Oct 19 2023, 3:40 PM
VPuffetMichel edited projects, added Editing-team (Kanban Board); removed Editing-team.Oct 19 2023, 3:42 PM
VPuffetMichel moved this task from Inbox to Ready to Be Worked On on the Editing-team (Kanban Board) board.Dec 4 2023, 7:28 PM
dchan changed the task status from Open to In Progress.Feb 29 2024, 10:04 AM
dchan mentioned this in T358747: Write a set of exercises for learning the VisualEditor source code.
ppelberg removed a project: Editing-team (Kanban Board).Jul 25 2024, 5:45 PM
ppelberg subscribed.

Meta: I'm removing this task from the Editing Team's current workboard as it does not require resolution at this time.

ppelberg added a parent task: T360799: [EPIC] Empower developers to author new Edit Checks and Suggestions and configure existing ones.Jul 25 2024, 5:46 PM
TBurmeister added a project: Documentation.Apr 10 2025, 4:31 PM
Aklapper changed the task status from In Progress to Open.Apr 11 2025, 10:19 PM

Resetting task status from "In Progress" to "Open" as this task has been "in progress" for more than one year (see T380300). Feel free to set that status again, or rather break down into smaller subtasks.

dchan closed this task as Resolved.Jun 30 2025, 12:40 PM

On review, I think there is enough here for now. The UI is a little underdocumented, but it contains less that is unique to VisualEditor than either the DM or CE do.

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