docs: temp WIP

Signed-off-by: msclock <msclock@qq.com>
serious-scaffold · Dec 1, 2023 · ec84dd5 · ec84dd5
1 parent 84efe48
commit ec84dd5
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 4 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,6 @@
 {
   "cmake.useCMakePresets": "always",
+  "cmake.options.statusBarVisibility": "visible",
   "files.exclude": {
     "**/.clangd/**": true
   },
@@ -97,5 +98,5 @@
     "memory_resource": "cpp",
     "numbers": "cpp",
     "semaphore": "cpp"
-  },
+  }
 }
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -8,7 +8,10 @@
       "generator": "Ninja",
       "hidden": true,
       "binaryDir": "${sourceDir}/out/build/${presetName}",
-      "installDir": "${sourceDir}/out/install/${presetName}"
+      "installDir": "${sourceDir}/out/install/${presetName}",
+      "cacheVariables": {
+        "CMAKE_VERBOSE_MAKEFILE": "FALSE"
+      }
     },
     {
       "name": "x64",

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -36,7 +36,7 @@ Commit messages must follow our convention based on the
 [Angular style](https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message)
 or the [Karma convention](https://karma-runner.github.io/4.0/dev/git-commit-msg.html):
 
-```txt
+```tex
 <type>[(scope)]: Subject
 
 [Body]
@@ -65,7 +65,7 @@ If you write a body, please add trailers at the end
 (for example issues and PR references, or co-authors),
 without relying on GitHub's flavored Markdown:
 
-```txt
+```tex
 Body.
 
 Issue #10: https://github.com/namespace/project/issues/10

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,2 @@
+```{include} ../CONTRIBUTING.md
+```
diff --git a/docs/development.md b/docs/development.md
@@ -0,0 +1 @@
+# Development
diff --git a/docs/index.md b/docs/index.md
@@ -4,6 +4,8 @@
 :hidden:
 Overview <self>
 cmake_workflow
+development
+contributing
 changelog
 api
 coverage