diff options
| author | Jon Robson <jdlrobson@gmail.com> | 2023-07-11 08:52:05 -0700 |
|---|---|---|
| committer | Jdlrobson <jrobson@wikimedia.org> | 2023-11-28 00:37:48 +0000 |
| commit | dfea3e8e5afff0dd94106f69a3421012e610ffda (patch) | |
| tree | f602bd84d6c2f2951a5ecb8b30a7b6e321c9608f /resources/README.md | |
| parent | dd4461c17de05ff236ed24acc8ee60b01f74e93f (diff) | |
| download | mediawikicore-dfea3e8e5afff0dd94106f69a3421012e610ffda.tar.gz mediawikicore-dfea3e8e5afff0dd94106f69a3421012e610ffda.zip | |
Add jsdoc with jsdoc-wmf-theme
jsduck is preventing us from using ES6 syntax and has not
been supported for some time. It is also difficult to setup
locally due its use of Ruby.
Introduce jsdoc and remove jsduck per T138401#9335987
Link to static copy of jsduck explaining the state
This does the bare minimum - the docs are built to the folder
docs/js/index.html and only one module is ported over to allow
us to provide feedback on the end result.
Bug: T138401
Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
Diffstat (limited to 'resources/README.md')
| -rw-r--r-- | resources/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/resources/README.md b/resources/README.md new file mode 100644 index 000000000000..26b2c10febf4 --- /dev/null +++ b/resources/README.md @@ -0,0 +1,5 @@ +> Please pardon our mess! We are currently in the process of revamping this documentation page so this page may appear incomplete. If you use this documentation we would value your feedback at [This MediaWiki page](https://www.mediawiki.org/wiki/Developer_Experience/Technical_Documentation). If needed you can view [the MediaWiki 1.41 frontend documentation page](https://doc.wikimedia.org/mediawiki-core/REL1_41/js/). + +This "resources" contains frontend resources (JavaScript and CSS) managed by [ResourceLoader](https://www.mediawiki.org/wiki/ResourceLoader). + +This documentation describes the public API that gadgets, skins and extensions can use to interact with MediaWiki. |