add readme to the doc

.github/workflows/api_doc.yml

@@ -36,12 +36,12 @@ jobs:
       - name: Build docs
         run: |
           npm install -g jsdoc
-          jsdoc src/js
+          npm run doc
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
           # Upload entire repository
-          path: './out'
+          path: './doc'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

README.md

@@ -19,6 +19,10 @@ Aladin Lite v3 is out! Please play with [Aladin Lite v3 at this link](https://al
 For integrating Aladin Lite into your personal website, please refer to this [release page](https://aladin.cds.unistra.fr/AladinLite/doc/release/).
 Always prefer using the latest version. If you want the new features without minding about the bugs coming with it, then the beta is the good way to go.
 
+## API documentation
+
+There is a new in progress API documentation at [this link](https://cds-astro.github.io/aladin-lite).
+
 ## Embed it into your projects
 
 You can embed Aladin Lite it into your webpages in two ways

package.json

@@ -41,7 +41,8 @@
     "preview": "vite preview",
     "test:build": "cd src/core && cargo test --release --features webgl2",
     "test:unit": "vitest run",
-    "doc": "jsdoc src/js && open out/index.html"
+    "doc": "jsdoc -d doc --readme README.md src/js && cp aladin-logo.png doc/",
+    "doc:dev": "npm run doc && open doc/index.html"
   },
   "devDependencies": {
     "happy-dom": "^10.11.0",