nits

Author: root-hbx

.github/workflows/deploy-docs.yml

@@ -0,0 +1,55 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - release/v2.0
+    paths:
+      - 'book/**'
+      - 'book.toml'
+      - '.github/workflows/deploy-docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: 'latest'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Build documentation
+        run: mdbook build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./book/docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -6,3 +6,6 @@ __pycache__/
 # UV virtual environment
 .venv/
 uv.lock
+
+# mdbook
+book/book/

book.toml

@@ -0,0 +1,45 @@
+[book]
+title = "StarPerf Documentation"
+authors = ["StarPerf Team"]
+description = "A comprehensive platform for simulating and analyzing mega-constellation satellite network performance"
+language = "en"
+multilingual = false
+src = "book/src"
+
+[build]
+build-dir = "book/docs"
+
+[output.html]
+default-theme = "dark"
+preferred-dark-theme = "navy"
+git-repository-url = "https://github.com/SpaceNetLab/StarPerf_Simulator"
+git-repository-icon = "fa-github"
+edit-url-template = "https://github.com/SpaceNetLab/StarPerf_Simulator/edit/main/book/src/{path}"
+site-url = "/StarPerf_Simulator/"
+cname = ""
+
+[output.html.fold]
+enable = true
+level = 0
+
+[output.html.search]
+enable = true
+limit-results = 30
+teaser-word-count = 30
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 1
+boost-paragraph = 1
+expand = true
+heading-split-level = 3
+
+[output.html.playground]
+editable = false
+copyable = true
+copy-js = true
+line-numbers = true
+
+[preprocessor.katex]
+
+[output.html.print]
+enable = true