feat: docs book (#16)

Author: lastsunday

.github/workflows/deploy.yml

@@ -0,0 +1,41 @@
+name: Deploy
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # To push a branch
+      pull-requests: write # To create a PR from that branch
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+          cargo install mdbook-mermaid
+      - name: Deploy GitHub Pages
+        run: |
+          # This assumes your book is in the root of your repository.
+          # Just add a `cd` here if you need to change to another directory.
+          cd docs
+          mdbook build
+          git worktree add gh-pages
+          git config user.name "Deploy from CI"
+          git config user.email ""
+          cd gh-pages
+          # Delete the ref to avoid keeping history.
+          git update-ref -d refs/heads/gh-pages
+          rm -rf *
+          mv ../book/* .
+          git add .
+          git commit -m "Deploy $GITHUB_SHA to gh-pages"
+          git push --force --set-upstream origin gh-pages

.github/workflows/docs-test.yml

@@ -0,0 +1,28 @@
+name: CI
+on: [push, pull_request]
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8
+      - name: Install Rust
+        run: |
+          rustup set profile minimal
+          rustup toolchain install stable
+          rustup default stable
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir bin
+          curl -sSL $url | tar -xz --directory=bin
+          echo "$(pwd)/bin" >> $GITHUB_PATH
+          cargo install mdbook-mermaid
+      - name: Run tests
+        run: |
+          cd docs
+          mdbook test

.gitignore

@@ -61,4 +61,9 @@ apps/server/api/*.wav
 asr_result*.wav
 
 # FVM Version Cache
-.fvm/
+.fvm/
+
+# book
+/index.html
+docs/book/
+docs/index.html

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 lastsunday
+Copyright (c) 2026 lastsunday
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -28,9 +28,9 @@ To make an self contained chatbot(self host all component,eg: llm,tts etc..), li
 
 ## Documentation
 
-You can find user guide documentation on [here](./docs/guide/README.md).
+You can find user guide documentation on [here](./docs/src/guide/README.md).
 
-You can find user development documentation on [here](/docs/development/README.md).
+You can find user development documentation on [here](/docs/src/development/README.md).
 
 ## Quick start
 
@@ -87,7 +87,7 @@ Expected workflow is: Fork -> Patch -> Push -> Pull Request
 
 ## FAQ
 
-See the [FAQ](./docs/guide/faq.md) file
+See the [FAQ](./docs/src/faq.md) file
 
 ## License
 

docs/README.md

@@ -0,0 +1,15 @@
+[book]
+title = "Chobits"
+authors = ["lastsunday"]
+language = "zh"
+src = "src"
+
+[preprocessor]
+
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
+[output]
+
+[output.html]
+additional-js = ["mermaid.min.js", "mermaid-init.js"]