From 94f4684c8e2a86e8db7f3b195dd631b71b510046 Mon Sep 17 00:00:00 2001 From: dbauszus-glx Date: Fri, 25 Oct 2024 08:52:49 +0100 Subject: [PATCH 1/3] Header links not working on deployed documentation --- jsdoc_mapp.json | 2 +- jsdoc_xyz.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/jsdoc_mapp.json b/jsdoc_mapp.json index ae3aa44e1..fb735989f 100644 --- a/jsdoc_mapp.json +++ b/jsdoc_mapp.json @@ -29,7 +29,7 @@ { "title": "XYZ", "id": "xyz", - "link": "/docs" + "link": "/xyz" } ] } diff --git a/jsdoc_xyz.json b/jsdoc_xyz.json index 291db2420..329246f89 100644 --- a/jsdoc_xyz.json +++ b/jsdoc_xyz.json @@ -31,7 +31,7 @@ { "title": "Mapp", "id": "mapp", - "link": "/docs/mapp" + "link": "/xyz/mapp" } ] } From 01e8ef5e9cc9ccdbd1f0400419304360201d7b0b Mon Sep 17 00:00:00 2001 From: dbauszus-glx Date: Fri, 25 Oct 2024 17:04:03 +0100 Subject: [PATCH 2/3] update mapp module documentation and links --- lib/README.md | 6 +++--- lib/mapp.mjs | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/README.md b/lib/README.md index a309c6328..a6e1b37dc 100644 --- a/lib/README.md +++ b/lib/README.md @@ -1,9 +1,9 @@ ## MAPP API -The MAPP API is a collection of javascript modules to interface with the [XYZ API](/docs). +The MAPP API is a collection of javascript modules to interface with the [XYZ API](/xyz). -The [mapp.mjs](/docs/mapp/module-mapp) module imports any modules required to create an interactive Openlayers mapview in a web document. +The [mapp.mjs](/xyz/mapp/module-mapp) module imports any modules required to create an interactive Openlayers mapview in a web document. ### MAPP/UI -A collection of modules for the creation of user interfaces to support the interaction with MAPP elements like the mapview, layer, and locations can be accessed through the [ui.mjs](/docs/mapp/module-ui). \ No newline at end of file +A collection of modules for the creation of user interfaces to support the interaction with MAPP elements like the mapview, layer, and locations can be accessed through the [ui.mjs](/xyz/mapp/module-ui). \ No newline at end of file diff --git a/lib/mapp.mjs b/lib/mapp.mjs index 94b5605cc..2a8e93717 100644 --- a/lib/mapp.mjs +++ b/lib/mapp.mjs @@ -7,7 +7,7 @@ The `mapp.mjs` module is used as entry point for the esbuild process to bundle t @requires /mapview @requires /layer -@requires /layer +@requires /location @requires /utils @requires /dictionary @requires /dictionaries From 953332c06013628b7307f993b40ed9caf31129af Mon Sep 17 00:00:00 2001 From: Robert Hurst Date: Mon, 28 Oct 2024 10:34:27 +0200 Subject: [PATCH 3/3] Update docs paths and fixes --- api/README.md | 12 ++++++------ express.js | 2 +- jsdoc_mapp.json | 7 +++---- jsdoc_xyz.json | 3 ++- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/api/README.md b/api/README.md index b5e8496c0..e6c501d85 100644 --- a/api/README.md +++ b/api/README.md @@ -6,7 +6,7 @@ An example Express application script is provided in the project root. XYZ API modules should be run with a Node.js runtime v18 or higher. -The [XYZ API](/docs/module-_api.html) module is located in the api folder as a requirement for using the offical Node.js runtime in Vercel's Edge Network. +The [XYZ API](/xyz/module-_api.html) module is located in the api folder as a requirement for using the offical Node.js runtime in Vercel's Edge Network. All other XYZ API modules are located in the /mod directory. @@ -16,12 +16,12 @@ The [clean-jsdoc-theme](https://www.npmjs.com/package/clean-jsdoc-theme) is used The XYZ API modules are: -### [Workspace](/docs/module-_workspace) +### [Workspace](/xyz/module-_workspace) -### [View](/docs/module-_view) +### [View](/xyz/module-_view) -### [Query](/docs/module-_query) +### [Query](/xyz/module-_query) -### [User](/docs/module-_user) +### [User](/xyz/module-_user) -### [Sign](/docs/module-_sign) \ No newline at end of file +### [Sign](/xyz/module-_sign) diff --git a/express.js b/express.js index edfa6d085..912f2a0f4 100644 --- a/express.js +++ b/express.js @@ -6,7 +6,7 @@ const cookieParser = require('cookie-parser') const app = express() -app.use('/docs', express.static('docs', { +app.use('/xyz', express.static('docs', { extensions: ['html'] })) diff --git a/jsdoc_mapp.json b/jsdoc_mapp.json index fb735989f..8cc010288 100644 --- a/jsdoc_mapp.json +++ b/jsdoc_mapp.json @@ -8,7 +8,6 @@ "plugins": [ "plugins/markdown" ], - "opts": { "encoding": "utf8", "readme": "./lib/README.md", @@ -22,9 +21,9 @@ "favicon": "../public/icons/favicon.ico", "menu": [ { - "title": "Github", - "id": "github", - "link": "https://github.com/GEOLYTIX/xyz" + "title": "Github", + "id": "github", + "link": "https://github.com/GEOLYTIX/xyz" }, { "title": "XYZ", diff --git a/jsdoc_xyz.json b/jsdoc_xyz.json index 329246f89..acb3318b6 100644 --- a/jsdoc_xyz.json +++ b/jsdoc_xyz.json @@ -1,7 +1,8 @@ { "source": { "include": [ - "api", "mod" + "api", + "mod" ], "includePattern": ".js$" },