summaryrefslogtreecommitdiffhomepage
path: root/docs/jsapi
diff options
context:
space:
mode:
authorPaul Spooren <mail@aparcar.org>2021-10-06 16:35:46 -1000
committerPaul Spooren <mail@aparcar.org>2021-10-08 17:16:04 -1000
commit56ef04849d46d355eccea8482cba43ec7ba582f6 (patch)
tree481b34fa3f5b6b02ca7c12ac40644fdb30f99745 /docs/jsapi
parentc1f972df1bb9a54048b4e6243c32e3ee856dd176 (diff)
CI: automatically update jsapi docs
Use a GitHub Action to keep the docs updated, the current onces are 14 month old and outdated. Use latest jsdoc package Add full URL to LuCI.html file in README.md Ignore generated HTML files via .gitignore Signed-off-by: Paul Spooren <mail@aparcar.org>
Diffstat (limited to 'docs/jsapi')
-rw-r--r--docs/jsapi/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/jsapi/README.md b/docs/jsapi/README.md
new file mode 100644
index 0000000000..ecd93766ad
--- /dev/null
+++ b/docs/jsapi/README.md
@@ -0,0 +1,5 @@
+# LuCI client side API documentation
+
+You can browse the JavaScript apis provided by LuCI here. A good starting point
+is the central [luci.js class](https://openwrt.github.io/luci/jsapi/LuCI.html).
+