JSDoc WMF theme
The JSDoc WMF theme is a user interface for reading JSDoc documentation based on the Wikimedia Design Style Guide.
- Code repository: git:jsdoc/wmf-theme
- NPM package: jsdoc-wmf-theme
- Issue tracker: #JSDoc WMF theme
- Example: MediaWiki API testing
Migration from JSDuck to JSDoc[edit]
As of November 2023, the Wikimedia Foundation Web, Design Systems, and Technical Documentation teams are in the process of migrating MediaWiki core and other Wikimedia JavaScript codebases from JSDuck, which is no longer maintained, to JSDoc. As part of this project, we're looking to learn more about how we can improve the JSDoc WMF theme.
See the tracking tasks on Phabricator to learn more about the plan to adopt JSDoc in all Wikimedia JavaScript codebases and the plan to migrate MediaWiki core to JSDoc.
How you can help[edit]
Let us know using the talk page:
- How do you use the existing frontend documentation? What do you use it to build or to do (for example: creating gadgets, upgrading MediaWiki, or another purpose)?
- How often do you refer to the documentation?
- Which documentation (in MediaWiki core or in another project) should we prioritize porting to the new system?
- What problems do you have with the JSDoc WMF theme?
- What did you like and what did you not like about the JSDuck documentation (for example: the MediaWiki core JSDuck docs)?