Rename the docs directory to book

.github/workflows/publish_website.yml

@@ -4,13 +4,13 @@ on:
   workflow_dispatch:
   pull_request:
     paths:
-      - docs/**
+      - book/**
       - .github/workflows/update-website.yml
   push:
     branches:
       - main
     paths:
-      - docs/**
+      - book/**
       - .github/workflows/update-website.yml
 
 jobs:
@@ -26,7 +26,7 @@ jobs:
       
       - name: Build the website
         run: |
-          cd asterinas/docs
+          cd asterinas/book
           mdbook build
 
       - name: Deploy website
@@ -45,7 +45,7 @@ jobs:
           cd temp_book
           git checkout --orphan newBranch
           git rm -rf *
-          cp -r ../asterinas/docs/book/* ./
+          cp -r ../asterinas/book/book/* ./
           git add -A
           git commit -am "Update website"
           git branch -D main

Makefile

@@ -305,8 +305,10 @@ docs: $(CARGO_OSDK)
 	@for dir in $(OSDK_CRATES); do \
 		(cd $$dir && cargo osdk doc --no-deps) || exit 1; \
 	done
-	@echo "" 						# Add a blank line
+
-	@cd docs && mdbook build 				# Build mdBook
+.PHONY: book
+book:
+	@cd book && mdbook build
 
 .PHONY: format
 format:
@@ -362,8 +364,8 @@ clean:
 	@cargo clean
 	@echo "Cleaning up OSDK workspace target files"
 	@cd osdk && cargo clean
-	@echo "Cleaning up documentation target files"
+	@echo "Cleaning up mdBook output files"
-	@cd docs && mdbook clean
+	@cd book && mdbook clean
 	@echo "Cleaning up test target files"
 	@$(MAKE) --no-print-directory -C test clean
 	@echo "Uninstalling OSDK"

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="docs/src/images/logo_en.svg" alt="asterinas-logo" width="620"><br>
+    <img src="book/src/images/logo_en.svg" alt="asterinas-logo" width="620"><br>
     A secure, fast, and general-purpose OS kernel written in Rust and compatible with Linux<br/>
     <a href="https://github.com/asterinas/asterinas/actions/workflows/test_x86.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/test_x86.yml/badge.svg?event=push" alt="Test x86-64" style="max-width: 100%;"></a>
     <a href="https://github.com/asterinas/asterinas/actions/workflows/test_riscv.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/test_riscv.yml/badge.svg?event=push" alt="Test riscv64" style="max-width: 100%;"></a>

README_CN.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="docs/src/images/logo_cn.svg" alt="asterinas-logo" width="620"><br>
+    <img src="book/src/images/logo_cn.svg" alt="asterinas-logo" width="620"><br>
     一个安全、快速、通用的操作系统内核，使用Rust编写，并与Linux兼容<br/>
     <a href="https://github.com/asterinas/asterinas/actions/workflows/test_x86.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/test_x86.yml/badge.svg?event=push" alt="Test x86-64" style="max-width: 100%;"></a>
     <a href="https://github.com/asterinas/asterinas/actions/workflows/test_riscv.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/test_riscv.yml/badge.svg?event=push" alt="Test riscv64" style="max-width: 100%;"></a>

README_JP.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img src="docs/src/images/logo_en.svg" alt="asterinas-logo" width="620"><br>
+    <img src="book/src/images/logo_en.svg" alt="asterinas-logo" width="620"><br>
     安全で高速、汎用的なOSカーネル。Rustで書かれ、Linuxと互換性があります<br/>
     <a href="https://github.com/asterinas/asterinas/actions/workflows/test_x86.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/test_x86.yml/badge.svg?event=push" alt="Test x86-64" style="max-width: 100%;"></a>
     <a href="https://github.com/asterinas/asterinas/actions/workflows/test_riscv.yml"><img src="https://github.com/asterinas/asterinas/actions/workflows/test_riscv.yml/badge.svg?event=push" alt="Test riscv64" style="max-width: 100%;"></a>

tools/bump_version.sh

@@ -123,8 +123,11 @@ update_all_docker_version_refs() {
     update_image_versions ${ASTER_SRC_DIR}/README_CN.md
     update_image_versions ${ASTER_SRC_DIR}/README_JP.md
     update_image_versions ${SCRIPT_DIR}/docker/README.md
-    update_image_versions ${DOCS_DIR}/src/kernel/intel_tdx.md
+
-    update_image_versions ${DOCS_DIR}/src/osdk/guide/intel-tdx.md
+    # Update Docker image versions in the Book
+    update_image_versions ${BOOK_DIR}/src/kernel/README.md
+    update_image_versions ${BOOK_DIR}/src/kernel/intel_tdx.md
+    update_image_versions ${BOOK_DIR}/src/osdk/guide/intel-tdx.md
 
     # Update Docker image versions in workflows
     ALL_WORKFLOWS=$(find "${ASTER_SRC_DIR}/.github/workflows/" -type f -name "*.yml")
@@ -139,10 +142,6 @@ update_all_docker_version_refs() {
             update_image_versions "$workflow"
         fi
     done
-
-    # Update Docker image versions in the documentation
-    GET_STARTED_PATH=${ASTER_SRC_DIR}/docs/src/kernel/README.md
-    update_image_versions $GET_STARTED_PATH
 }
 
 # Update project dependencies (Cargo.toml and Cargo.lock)
@@ -214,7 +213,7 @@ update_tag_version() {
 
 SCRIPT_DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
 ASTER_SRC_DIR=${SCRIPT_DIR}/..
-DOCS_DIR=${ASTER_SRC_DIR}/docs
+BOOK_DIR=${ASTER_SRC_DIR}/book
 OSTD_CARGO_TOML_PATH=${ASTER_SRC_DIR}/ostd/Cargo.toml
 OSTD_TEST_CARGO_TOML_PATH=${ASTER_SRC_DIR}/ostd/libs/ostd-test/Cargo.toml
 OSTD_MACROS_CARGO_TOML_PATH=${ASTER_SRC_DIR}/ostd/libs/ostd-macros/Cargo.toml