cataclysmbnteam · scarf005 · Sep 20, 2023 · Sep 6, 2023 · Sep 11, 2023 · Sep 11, 2023
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -1,45 +1,45 @@
-name: Generate Documentation
-
-permissions:
-  contents: write
+name: Deploy starlight documentation to GitHub Pages
 
 on:
   push:
     branches: [upload]
   workflow_dispatch:
 
-concurrency:
-  group: documentation
-  cancel-in-progress: true
+
+defaults:
+  run:
+    working-directory: doc
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
 
 jobs:
-  documentation:
+  build:
     runs-on: ubuntu-22.04
-
+    environment: github-pages
     steps:
-      - name: checkout repository
+      - name: Checkout your repository using git
         uses: actions/checkout@v3
-
-      - name: cache css
-        id: cache-css
-        uses: actions/cache@v3
+      - name: Install, build, and upload site
+        uses: withastro/action@v0
         with:
-          key: doxygen-css-cache
-          path: ./doxygen_doc/doxygen-awesome-css
-
-      - if: ${{ steps.cache-css.outputs.cache-hit != 'true' }}
-        name: download css
-        run: |
-          git clone https://github.com/jothepro/doxygen-awesome-css ./doxygen_doc/doxygen-awesome-css
-      - name: run doxygen
-        uses: mattnotmitt/doxygen-action@v1.9.2
-        with:
-          working-directory: .
-          doxyfile-path: ./doxygen_doc/Doxyfile
-          # additional-packages: font-fira-code
-
-      - name: deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./doxygen_doc/html/
+          path: doc
+          node-version: 20
+          package-manager: pnpm
+          pnpm-version: 8.7.x
+        env:
+          CUSTOM_SITE_URL: ${{ vars.CUSTOM_SITE_URL }}
+          CUSTOM_REPO_URL: ${{ vars.CUSTOM_REPO_URL }}
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-22.04
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml
@@ -0,0 +1,45 @@
+name: Generate Documentation
+
+permissions:
+  contents: write
+
+on:
+  push:
+    branches: [upload]
+  workflow_dispatch:
+
+concurrency:
+  group: documentation
+  cancel-in-progress: true
+
+jobs:
+  documentation:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v3
+
+      - name: cache css
+        id: cache-css
+        uses: actions/cache@v3
+        with:
+          key: doxygen-css-cache
+          path: ./doxygen_doc/doxygen-awesome-css
+
+      - if: ${{ steps.cache-css.outputs.cache-hit != 'true' }}
+        name: download css
+        run: |
+          git clone https://github.com/jothepro/doxygen-awesome-css ./doxygen_doc/doxygen-awesome-css
+      - name: run doxygen
+        uses: mattnotmitt/doxygen-action@v1.9.2
+        with:
+          working-directory: .
+          doxyfile-path: ./doxygen_doc/Doxyfile
+          # additional-packages: font-fira-code
+
+      - name: deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doxygen_doc/html/
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,5 +1,7 @@
 Cataclysm is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
 
+Documentation site (doc/*, excluding doc/src/content/docs/*) is licensed under the AGPL 3.0-only license, see doc/LICENSE for text of license.
+
 GNU Unifont (data/font/unifont.ttf) is licensed under GNU General Public License v2+ with the GNU font embedding exception. Visit http://unifoundry.com/LICENSE.txt for details.
 
 Terminus Font (data/font/terminus.ttf) is licensed under the SIL Open Font License (see LICENSE-OFL-Terminus-Font.txt).
@@ -14,8 +16,6 @@ Lua (src/lua/*) is licensed under the MIT license, see src_lua/LICENSE.md for te
 
 sol2 (src/sol/*) is licensed under the MIT license, see src/sol/sol.hpp for text of license.
 
-
-
 fmtlib (src/fmtlib_*) is licensed under the MIT license (https://github.com/fmtlib/fmt/blob/master/LICENSE.rst). The full license text is as follows:
 
 # Copyright (c) 2012 - present, Victor Zverovich
@@ -55,13 +55,13 @@ libbacktrace is licensed under a BSD license (https://github.com/ianlancetaylor/
 # met:
 
 #     (1) Redistributions of source code must retain the above copyright
-#     notice, this list of conditions and the following disclaimer. 
+#     notice, this list of conditions and the following disclaimer.
 
 #     (2) Redistributions in binary form must reproduce the above copyright
 #     notice, this list of conditions and the following disclaimer in
 #     the documentation and/or other materials provided with the
-#     distribution.  
-    
+#     distribution.
+
 #     (3) The name of the author may not be used to
 #     endorse or promote products derived from this software without
 #     specific prior written permission.

diff --git a/Makefile b/Makefile
@@ -37,7 +37,7 @@
 #   Run: make NATIVE=win32
 # OS X
 #   Run: make NATIVE=osx OSX_MIN=11
-#     It is highly recommended to supply OSX_MIN > 10.11
+#     It is highly recommended to supply OSX_MIN > 11
 #     otherwise optimizations are automatically disabled with -O0
 
 # Build types:

diff --git a/README.ko.md b/README.ko.md
@@ -1,7 +1,7 @@
 # 카타클리즘: 밝은 밤
 
 <header align="center">
-  <a><img src="doc/img/readme-title.png" title="우측 위부터 시계방향으로 Chaosvolt (x2), ExecutorBill, scarf005의 스크린샷"></a>
+  <a><img src="doc/src/content/docs/en/contribute/img/readme-title.png" title="우측 위부터 시계방향으로 Chaosvolt (x2), ExecutorBill, scarf005의 스크린샷"></a>
 
 [![en][icon-en]][en] [![ko][icon-ko]][ko]
 
@@ -49,17 +49,15 @@
 
 ## 빌드하기
 
-[COMPILING.md](doc/COMPILING/COMPILING.md)를 참고하세요 - 리눅스, OS X, 윈도우즈와 BSD에서 빌드하기
-위한 일반적인 정보부터 보다 자세한 레시피가 담겨있습니다.
-[COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md)에서 지원하는 컴파일러를 확인할 수 있습니다.
-더 자세한 정보는 [doc/](https://github.com/cataclysmbnteam/cataclysm-BN/tree/upload/doc)에서도
-찾아볼 수 있습니다.
+- [makefile](doc/src/content/docs/en/dev/guides/building/makefile.md)로 빌드하기: Linux, macOS,
+  BSD를 지원합니다.
+- [MSYS2](doc/src/content/docs/en/dev/guides/building/msys.md)
+- [vcpkjg](doc/src/content/docs/en/dev/guides/building/vs_vcpkg.md)
+- [cmake](doc/src/content/docs/en/dev/guides/building/cmake.md)
+- [지원하는 컴파일러 목록](doc/src/content/docs/en/dev/reference/compiler_support.md)
 
-또한 다음 빌드 가이드도 있습니다.
-
-- 윈도우즈에서 `MSYS2`로 빌드하기 [COMPILING-MSYS.md](doc/COMPILING/COMPILING-MSYS.md)
-- 윈도우즈에서 `vcpkg`로 빌드하기 [COMPILING-VS-VCPKG.md](doc/COMPILING/COMPILING-VS-VCPKG.md)
-- `cmake`로 빌드하기 [COMPILING-CMAKE.md](doc/COMPILING/COMPILING-CMAKE.md) (_비공식 가이드_)
+자세한 내용은 [공식 문서](https://docs.cataclysmbn.org/en/dev/guides/building/cmake/)를
+참고해주세요.
 
 ## 기여하기
 
@@ -69,17 +67,28 @@
 > 배포되지만, 다른 소프트웨어 라이선스에 따라 배포됩니다. 다른 소프트웨어 라이선스에 따라 배포되는
 > 파일들은 각 파일에 라이선스 공지가 포함되어 있습니다.
 
-[CONTRIBUTING.ko.md](./doc/CONTRIBUTING.ko.md)에서 자세한 내용을 확인할 수 있습니다.
+[공식 사이트](https://docs.cataclysmbn.org/ko/contribute/contributing/)에서 자세한 내용을 확인할 수
+있습니다.
+
+## 공식 사이트
+
+게임플레이 및 개발 가이드는 [doc](./doc/src/content/docs/) 디렉토리에 마크다운으로 작성되어
+있습니다. 또는
+
+- [공식 문서 사이트](https://docs.cataclysmbn.org/ko/)를 방문하거나
+- [로컬에서 사이트를 빌드하고 실행](./doc/src/content/docs/en/contribute/docs.md)할 수 있습니다.
 
 ## 커뮤니티
 
+[![공식 문서](https://img.shields.io/badge/Docs-LightGray?style=for-the-badge&logo=astro)][docs]
 [![Discussions](https://img.shields.io/badge/포럼에서%20토론하기-black?style=for-the-badge&logo=github)][discussion]
 [![Discord](https://img.shields.io/discord/830879262763909202?style=for-the-badge&logo=discord&label=공식%20디스코드%20서버)][discord]
 [![Discussions](https://img.shields.io/badge/CDDA%20모딩%20커뮤니티-green?style=for-the-badge&logo=discord)][modding]
 
 [discussion]: https://github.com/cataclysmbnteam/cataclysm-BN/discussions
 [discord]: https://discord.gg/XW7XhXuZ89
 [modding]: https://discord.gg/B5q4XCa "비공식 DDA모딩 커뮤니티에도 BN 채널이 있습니다."
+[docs]: https://docs.cataclysmbn.org "공식 BN 개발문서"
 
 ## 자주 묻는 질문
 
@@ -105,11 +114,11 @@
 
 게임 내에서 `Submit a bug report on github`를 실행하여 이슈를 제출할 수 있습니다.
 
-| 1. 옵션 (ESC) -> 디버그 메뉴 (a) |         2. 정보 (i)          |
-| :------------------------------: | :--------------------------: |
-|   ![](doc/img/readme-bug1.png)   | ![](doc/img/readme-bug2.png) |
-|     3. 버그 리포트 제출 (U)      |  4. 이슈 링크가 생성됩니다   |
-|   ![](doc/img/readme-bug3.png)   | ![](doc/img/readme-bug4.png) |
+|              1. 옵션 (ESC) -> 디버그 메뉴 (a)               |                         2. 정보 (i)                         |
+| :---------------------------------------------------------: | :---------------------------------------------------------: |
+| ![](doc/src/content/docs/en/contribute/img/readme-bug1.png) | ![](doc/src/content/docs/en/contribute/img/readme-bug2.png) |
+|                   3. 버그 리포트 제출 (U)                   |                  4. 이슈 링크가 생성됩니다                  |
+| ![](doc/src/content/docs/en/contribute/img/readme-bug3.png) | ![](doc/src/content/docs/en/contribute/img/readme-bug4.png) |
 
 `버전 및 환경 설정(Version and configuration)` 항목이 채워진 이슈가 브라우저에서 열립니다.
 

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Cataclysm: Bright Nights
 
 <header align="center">
-  <a><img src="doc/img/readme-title.png" title="screenshots of (clockwise from upper-right: Chaosvolt (x2), ExecutorBill, scarf005"></a>
+  <a><img src="doc/src/content/docs/en/contribute/img/readme-title.png" title="screenshots of (clockwise from upper-right: Chaosvolt (x2), ExecutorBill, scarf005"></a>
 
 [![en][icon-en]][en] [![ko][icon-ko]][ko]
 
@@ -47,40 +47,48 @@ Find a way to stop the Cataclysm ... or become one of its strongest monsters.
 [clone]: https://github.com/cataclysmbnteam/Cataclysm-BN/ "clone from our GitHub repo"
 [clone-badge]: https://img.shields.io/badge/Clone%20From%20Repo-black?style=for-the-badge&logo=github
 
-## Compile
+## Building
 
-Please read [COMPILING.md](doc/COMPILING/COMPILING.md) - it covers general information and more
-specific recipes for Linux, OS X, Windows and BSD. See
-[COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md) for details on which compilers we support.
-And you can always dig for more information in
-[doc/](https://github.com/cataclysmbnteam/Cataclysm-BN/tree/upload/doc).
+- [with makefile](doc/src/content/docs/en/dev/guides/building/makefile.md): supports Linux, macOS,
+  and BSD.
+- [with MSYS2](doc/src/content/docs/en/dev/guides/building/msys.md)
+- [with vcpkjg](doc/src/content/docs/en/dev/guides/building/vs_vcpkg.md)
+- [with cmake](doc/src/content/docs/en/dev/guides/building/cmake.md)
+- [which compilers we support](doc/src/content/docs/en/dev/reference/compiler_support.md)
 
-We also have the following build guides:
+Please read the [official docs](https://docs.cataclysmbn.org/en/dev/guides/building/cmake/) for
+details.
 
-- Building on Windows with `MSYS2` at [COMPILING-MSYS.md](doc/COMPILING/COMPILING-MSYS.md)
-- Building on Windows with `vcpkg` at [COMPILING-VS-VCPKG.md](doc/COMPILING/COMPILING-VS-VCPKG.md)
-- Building with `cmake` at [COMPILING-CMAKE.md](doc/COMPILING/COMPILING-CMAKE.md) (_unofficial
-  guide_)
-
-## Contribute
+## Contributing
 
 > Cataclysm: Bright Nights developed under Creative Commons Attribution ShareAlike 3.0 license. The
 > code and content of the game is free to use, modify, and redistribute for any purpose whatsoever.
 > See http://creativecommons.org/licenses/by-sa/3.0/ for details. Some code distributed with the
 > project is not part of the project and is released under different software licenses, the files
 > covered by different software licenses have their own license notices.
 
-Please see [CONTRIBUTING.md](./doc/CONTRIBUTING.md) for details.
+Please check the [official docs](https://docs.cataclysmbn.org/en/contribute/contributing/) for
+details.
+
+## Documentation
+
+Gameplay and developing documentation is available in the [doc](./doc/src/content/docs/) directory
+in markdown format. You can also
+
+- visit the [official docs](https://docs.cataclysmbn.org/en/) site
+- [build and serve the documentation locally](./doc/src/content/docs/en/contribute/docs.md)
 
 ## Community
 
+[![Official Docs](https://img.shields.io/badge/Docs-LightGray?style=for-the-badge&logo=astro)][docs]
 [![Discussions](https://img.shields.io/badge/Discussions-black?style=for-the-badge&logo=github)][discussion]
 [![Discord](https://img.shields.io/discord/830879262763909202?style=for-the-badge&logo=discord)][discord]
 [![Discussions](https://img.shields.io/badge/CDDA%20Modding-green?style=for-the-badge&logo=discord)][modding]
 
 [discussion]: https://github.com/cataclysmbnteam/Cataclysm-BN/discussions
 [discord]: https://discord.gg/XW7XhXuZ89
 [modding]: https://discord.gg/B5q4XCa "Unofficial DDA modding community discord has a BN channel"
+[docs]: https://docs.cataclysmbn.org "Official BN documentation"
 
 ## Frequently Asked Questions
 
@@ -107,11 +115,11 @@ be submitted via debug menu.
 
 Run `Submit a bug report on github` inside the game to submit an issue.
 
-| 1. open Options (ESC) -> Debug Menu (a) |         2. open Info (i)         |
-| :-------------------------------------: | :------------------------------: |
-|      ![](doc/img/readme-bug1.png)       |   ![](doc/img/readme-bug2.png)   |
-|  3. Submit a bug report on github (U)   | 4. An link to issue is generated |
-|      ![](doc/img/readme-bug3.png)       |   ![](doc/img/readme-bug4.png)   |
+|           1. open Options (ESC) -> Debug Menu (a)           |                      2. open Info (i)                       |
+| :---------------------------------------------------------: | :---------------------------------------------------------: |
+| ![](doc/src/content/docs/en/contribute/img/readme-bug1.png) | ![](doc/src/content/docs/en/contribute/img/readme-bug2.png) |
+|            3. Submit a bug report on github (U)             |              4. An link to issue is generated               |
+| ![](doc/src/content/docs/en/contribute/img/readme-bug3.png) | ![](doc/src/content/docs/en/contribute/img/readme-bug4.png) |
 
 It will open a bug report on browser with `Version and configuration` filled in.