We're using JSDoc annotations, but we aren't actually generating the docs or even providing a way for the developer to do so themselves.
The base CodeMirror class is meant to be extendable by extensions, so having the docs published would be beneficial.
Acceptance criteria
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | Feature | None | T166098 Syntax sensitive and highlighting source code editor for template code wanted | ||
| Resolved | Feature | Bhsd | T95100 Add autocompletion to CodeMirror extension | ||
| Resolved | Feature | MusikAnimal | T181677 Implement syntax highlight for U+00A0 (no-break space, nbsp) | ||
| Resolved | Feature | MusikAnimal | T301615 Show syntax highlighting on View Source/protected pages | ||
| Resolved | MusikAnimal | T214989 Allow CodeMirror to be used for other textareas with WikiEditor | |||
| In Progress | Goal | None | T259059 Upgrade to CodeMirror 6 | ||
| Resolved | MusikAnimal | T359986 Generate docs for CodeMirror 6 |
Change 1012713 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):
[mediawiki/extensions/CodeMirror@master] CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags
Change 1012723 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):
[integration/config@master] Zuul: [mediawiki/extensions/CodeMirror] Publish JS documentation
Change #1012723 merged by jenkins-bot:
[integration/config@master] Zuul: [mediawiki/extensions/CodeMirror] Publish JS documentation
Change #1012713 merged by jenkins-bot:
[mediawiki/extensions/CodeMirror@master] CM6: Add jsdoc build step, fix JSDoc annotations, and add @stable tags
All done with @hashar's help. We are now live at https://doc.wikimedia.org/CodeMirror/
I don't think QA resources are needed. Resolving!
I don’t see it listed on https://doc.wikimedia.org/, don’t we need yet another patch to add it to the listing?
Change #1015209 had a related patch set uploaded (by MusikAnimal; author: MusikAnimal):
[integration/docroot@master] doc: add CodeMirror to opensource.yaml
It's listed at https://doc.wikimedia.org/index/. I've just added a patch to have it added to the "Components" list on the doc homepage.
Change #1015209 merged by jenkins-bot:
[integration/docroot@master] doc: add CodeMirror to opensource.yaml
Mentioned in SAL (#wikimedia-operations) [2024-03-28T20:22:13Z] <hashar@deploy1002> Started deploy [integration/docroot@c89a404]: add CodeMirror to opensource.yaml - T359986
Mentioned in SAL (#wikimedia-operations) [2024-03-28T20:22:20Z] <hashar@deploy1002> Finished deploy [integration/docroot@c89a404]: add CodeMirror to opensource.yaml - T359986 (duration: 00m 06s)
https://doc.wikimedia.org/index/ is what I have suggested because I thought we had no MediaWiki extension on the front page. Turns out that the index is a bit cluttered with a lot of various projects and extensions are under MediaWiki components section.
MediaWiki-extensions-CodeMirror has been promoted on the frontpage of doc.wikimedia.org . Congratulations!