Apparently there is no standard way of documenting Vue component properties, but the most accepted way seems to be to use JSDoc, with some decent tooling for building doc pages or reusing it in storybooks. PHPStorm doesn't support it yet but they support an intermediary format and a tool to auto-generate it from JSDoc.
We can start documenting this component using JSDoc and start exploring the tooling mentioned above.
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | Sgs | T296646 [Epic] Migration of front-end modules to Vue.js components | |||
| Resolved | KStoller-WMF | T329033 [Internship] Modernization of web interfaces using Vue.js | |||
| In Progress | None | T329037 Refactor the "Add a link" on-boarding dialog to Vue | |||
| Open | None | T340453 [Epic] FY 2023-24 Growth Maintenance Work | |||
| Stalled | None | T333346 Add documentation for "Add a link" on-boarding dialog |
Change 906544 had a related patch set uploaded (by Viviana Yanez; author: Viviana Yanez):
[mediawiki/extensions/GrowthExperiments@master] WIP documentation/frontend: document AddlinkDialog using JSDoc
Change 909995 had a related patch set uploaded (by Viviana Yanez; author: Sergio Gimeno):
[mediawiki/extensions/GrowthExperiments@master] Frontend documentation: add OnboardingDialog component documentation
Change 909995 abandoned by Viviana Yanez:
[mediawiki/extensions/GrowthExperiments@master] Frontend documentation: add OnboardingDialog component documentation
Reason:
Change 906544 merged by jenkins-bot:
[mediawiki/extensions/GrowthExperiments@master] Frontend documentation: add content to OnboardingDialog component demo page
The current documentation is written by hand. Ideally we would like to have an automated process for creating such docs based on the JSDoc annotations. We should work on a proper setup for this eventually, maybe reusing some of the setup for the codex library/docs.