From 5029107fb984748a5c813ae161d5203da4f8c4b9 Mon Sep 17 00:00:00 2001
From: squid233 <60126026+squid233@users.noreply.github.com>
Date: Sat, 6 Apr 2024 16:27:52 +0800
Subject: [PATCH] Update document and workflow

---
 .github/workflows/javadoc.yml                 | 39 ++++++++++++-------
 README.md                                     |  5 ++-
 doc/legal/README.md                           |  2 +-
 .../src/main/java/overrungl/nfd/NFD.java      |  1 -
 4 files changed, 28 insertions(+), 19 deletions(-)

diff --git a/.github/workflows/javadoc.yml b/.github/workflows/javadoc.yml
index 38daf65d..3e43795b 100644
--- a/.github/workflows/javadoc.yml
+++ b/.github/workflows/javadoc.yml
@@ -2,22 +2,31 @@ name: Javadoc
 
 on: [ release, workflow_dispatch ]
 
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
 jobs:
   build:
-    strategy:
-      matrix:
-        java: [
-          22
-        ]
-        os: [ ubuntu-latest ]
-    runs-on: ${{ matrix.os }}
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up JDK ${{ matrix.java }}
+      - name: Set up JDK
         uses: actions/setup-java@v4
         with:
           java-version: |
-            ${{ matrix.java }}
+            22
           distribution: 'temurin'
       - name: Grant execute permission for gradlew
         if: ${{ runner.os != 'Windows' }}
@@ -26,10 +35,10 @@ jobs:
         uses: gradle/actions/setup-gradle@v3
       - name: Execute Gradle build
         run: ./gradlew aggregateJavadoc
-      - name: Deploy Javadoc
-        uses: JamesIves/github-pages-deploy-action@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages
-          folder: build/docs/javadoc
-          clean: true
+          path: 'build/docs/javadoc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
index b96bc51e..3a868f05 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,12 @@ which enables cross-platform access to a set of C/C++ library bindings, and prov
 [LWJGL 3](https://github.com/LWJGL/lwjgl3) is also a Java library that enables native access.
 
 LWJGL 3 uses JNI to access native functions,
-but OverrunGL uses [FFM API](https://openjdk.org/jeps/454), which has better performance.
+but OverrunGL uses [FFM API](https://openjdk.org/jeps/454), which provides better memory management.
 
 ## Getting Started
 
 You can check our [wiki](https://github.com/Over-Run/overrungl/wiki) or
-the [samples](modules/samples/src/test/java/overrungl/demo).
+the [samples](modules/samples/src/main/java/overrungl/demo).
 
 ## Import as a Dependency
 
@@ -93,6 +93,7 @@ You must enable the access of OverrunGL by adding a VM argument or a manifest at
 
 - [Discussions](https://github.com/Over-Run/overrungl/discussions)
 - [Discord: ![Discord](https://img.shields.io/discord/1048545705553313862)](https://discord.gg/UKRJapDKgX)
+- [QQ群](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=ahhT6p-D0HlrGat3lFDLlSB953umWh5Z&authKey=KP0UtgQg1rW8MGNV20zmxRI7OxzijOproIRsCxe8mrWD6CHBiVo0Lhr0vvrnDYAH&noverify=0&group_code=1078745269)
 
 ## Release Notes
 
diff --git a/doc/legal/README.md b/doc/legal/README.md
index 41b0b80c..3fa54901 100644
--- a/doc/legal/README.md
+++ b/doc/legal/README.md
@@ -10,4 +10,4 @@ Files:
 
 - modules/lwjgl/core/src/main/java/org/lwjgl/system/MemoryManage.java -> [modules/overrungl.core/src/main/java/overrungl/util/DebugAllocator.java](../../modules/overrungl.core/src/main/java/overrungl/util/DebugAllocator.java)
 - modules/lwjgl/core/src/main/java9/org/lwjgl/system/StackWalkUtil.java -> [modules/overrungl.core/src/main/java/overrungl/util/StackWalkUtil.java](../../modules/overrungl.core/src/main/java/overrungl/util/StackWalkUtil.java)
-- modules/samples/src/test/java/org/lwjgl/demo/util/IOUtil.java -> [modules/samples/src/main/java/overrungl/demo/util/IOUtil.java](../../modules/samples/src/test/java/overrungl/demo/util/IOUtil.java)
+- modules/samples/src/test/java/org/lwjgl/demo/util/IOUtil.java -> [modules/samples/src/main/java/overrungl/demo/util/IOUtil.java](../../modules/samples/src/main/java/overrungl/demo/util/IOUtil.java)
diff --git a/modules/overrungl.nfd/src/main/java/overrungl/nfd/NFD.java b/modules/overrungl.nfd/src/main/java/overrungl/nfd/NFD.java
index 76c36fef..25b3ddc6 100644
--- a/modules/overrungl.nfd/src/main/java/overrungl/nfd/NFD.java
+++ b/modules/overrungl.nfd/src/main/java/overrungl/nfd/NFD.java
@@ -240,7 +240,6 @@ default MethodHandle NFD_PathSet_EnumNextU8() {
     @Entrypoint("NFD_OpenDialogN")
     NFDResult nopenDialogN(@NativeType("nfdnchar_t**") MemorySegment outPath, NFDNFilterItem filterList, int filterCount, @NativeType("const nfdnchar_t*") MemorySegment defaultPath);
 
-
     /**
      * single file open dialog
      *