Merge pull request #302 from modelix/fix/modelql-docs

MODELIX-591: Add modeQL doc tree and generate latest API symlink

Author: mhuster23

.github/workflows/docs.yaml

@@ -24,6 +24,13 @@ jobs:
           path: build/dokka
       - name: Generate Docs with Dokka
         run: ./gradlew dokkaHtmlMultiModule
+      - name: Create symlink to latest version
+        run: |
+          cd build/dokka
+          latestVersion=$(for n in *; do printf '%s\n' "$n"; done | sort -V | grep -E "^[0-9]+\.[0-9]+" | tail -n1)
+          if [[ -z "${latestVersion}" ]]; then
+            ln -sf ${latestVersion} latest
+          fi
       - name: Publish to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

build.gradle.kts

@@ -329,6 +329,17 @@ fun createDocsIndexPage(): String {
                                     ?.filter { it.isDirectory && !it.name.startsWith('.') }
                                     ?.sortedByDescending { Version.parse(it.name) }
                                 if (versionDirs != null) {
+                                    div("table-row") {
+                                        div("main-subrow") {
+                                            div("w-100") {
+                                                span("inline-flex") {
+                                                    a(href = "/latest") {
+                                                        +"modelix.core LATEST"
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
                                     for (versionDir in versionDirs) {
                                         val versionIndex = versionDir.resolve("index.html")
                                         if (versionIndex.exists()) {

docs/global/modules/core/partials/nav-howto.adoc

@@ -2,3 +2,4 @@
 * xref:core:howto/usage-model-api-gen-gradle.adoc[]
 * xref:core:howto/usage-light-model-client.adoc[]
 * xref:core:howto/testing-against-model-api.adoc[]
+* xref:core:howto/modelql.adoc[]