diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml
index deb47b9fceae2002d753b98b0cd0513a445f4e42..6f89db1e523a966a0e1a029aca5d852d15a9cc5b 100644
--- a/.github/workflows/jekyll-gh-pages.yml
+++ b/.github/workflows/jekyll-gh-pages.yml
@@ -32,9 +32,10 @@ jobs:
           submodules: false
 
       - name: Doxygen Action
-        run: mattnotmitt/doxygen-action@v1.9.5
-        working-directory: .
-        doxyfile-path: ./Doxyfile
+        uses: mattnotmitt/doxygen-action@v1.9.5
+        with:
+          working-directory: .
+          doxyfile-path: ./Doxyfile
 
       - name: Setup Pages
         uses: actions/configure-pages@v3
diff --git a/.gitignore b/.gitignore
index 005c0c1ed4ea3c8db18b5ecaac3ee3e7bc8e6e4e..bd7f9df9e610fd227cf9409ff3e48c2873da738e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,6 +3,7 @@
 ./deps/googletest
 ./deps/jsoncpp
 ./deps/benchmark
+./docs/doxy/
 build/*
 build_*
 cmake-build-*/*
diff --git a/README.md b/README.md
index 763ce7b35711faa62a97673cde112a182d05825b..91acd9054c2094f83c62a0fecade9c28453cf262 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ miniob 设计的目标是面向在校学生、数据库从业者、爱好者，
 4. [开发环境搭建(本地调试, 适用 Linux 和 Mac)](docs/how_to_dev_miniob_by_vscode.md)
 5. [开发环境搭建(远程调试, 适用于 Window, Linux 和 Mac)](docs/how_to_dev_in_docker_container_by_vscode.md)
 6. [miniob 词法语法解析开发与测试](docs/miniob-sql-parser.md)
+7. [doxygen 代码文档](docs/doxy/html/index.html)
 
 更多的文档, 可以参考 docs 目录下的文档, 为了帮助大家更好的学习数据库基础知识, OceanBase 社区提供了一系列教程, 建议学习: