docs: ドキュメントの追加 (#166)

* fix: requirements.txtがutf16だったのでutf8

* chore: venvのignore追加

* docs: とりあえずコマンドひととおり

* ci: indexファイルの検証追加

* docs: featuresのドキュメント追加

* docs: features/index 更新

* Apply suggestions from code review

* Update docs/for-users/commands/clear.md

.github/workflows/mkdocs.yml

@@ -1,35 +1,47 @@
-name: 📚 Deploy MkDocs
+name: 📚 Build & Deploy MkDocs
 on:
   push:
     branches:
       - main
+  pull_request:
+  merge_group:
 
-jobs: 
+jobs:
   build:
     runs-on: ubuntu-latest
-    
+
     steps:
       - name: 📥 Checkout ${{ github.repository }}
         uses: actions/checkout@v4
 
       - name: 🐍 Setup Python 3.10
         uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: "3.10"
 
       - name: 📄 Install Material for MkDocs
         run: pip install -r requirements.txt
-
+
+      - name: Generate list
+        run: |
+          chmod +x ./scripts/generate-index-list.sh
+          ./scripts/generate-index-list.sh
+
+          # 差分があればエラー
+          git config core.filemode false
+          git diff --exit-code
+
       - name: 🏗️ Build MkDocs
         run: python -m mkdocs build --verbose --clean --strict
-      
+
       - name: 📤 Upload Pages Artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: site
 
   deploy:
     runs-on: ubuntu-latest
+    if: github.event_name == 'push'
     needs: build
     permissions:
       pages: write

.gitignore

@@ -1,5 +1,6 @@
 .gradle
 .idea
+.venv
 build
 
 store/

docs/for-users/commands/.index-template.md

@@ -0,0 +1,3 @@
+# コマンド一覧
+
+<!-- COMMANDS -->

docs/for-users/commands/alias.md

@@ -0,0 +1,55 @@
+# alias
+
+エイリアスに関する操作を行えます。
+
+## 使い方
+
+エイリアスに関する操作を行うには、以下のコマンドを使用します。
+
+### エイリアスの作成
+
+エイリアスを作成します。
+
+```text
+/alias create <タイプ> <検索文字列> <置換文字列>
+```
+
+- `<タイプ>`: エイリアスの種類を指定します。利用可能な種類は `Text`、`Regex`、`Emoji` です。
+- `<検索文字列>`: 置き換える条件となる文字列を指定します。
+- `<置換文字列>`: 検索文字列にマッチした場合に置き換える文字列を指定します。
+
+### エイリアスの更新
+
+既存のエイリアスを更新します。
+
+```text
+/alias update <エイリアス> [<新しいタイプ>] [<新しい検索文字列>] [<新しい置換文字列>]
+```
+
+- `<エイリアス>`: 更新するエイリアスを指定します。
+- `<新しいタイプ>`: 新しいエイリアスの種類を指定します（オプション）。
+- `<新しい検索文字列>`: 新しい検索文字列を指定します（オプション）。
+- `<新しい置換文字列>`: 新しい置換文字列を指定します（オプション）。
+
+### エイリアスの削除
+
+エイリアスを削除します。
+
+```text
+/alias delete <エイリアス>
+```
+
+- `<エイリアス>`: 削除するエイリアスを指定します。
+
+### エイリアスの一覧表示
+
+設定されているエイリアスの一覧を表示します。
+
+```text
+/alias list
+```
+
+
+## 関連するページ
+
+- [Alias 機能について](../features/alias.md)

docs/for-users/commands/clear.md

@@ -0,0 +1,12 @@
+# clear
+
+予定されているメッセージの読み上げを中止します。  
+ボイスチャンネルに参加している際に、これまでに予定されていた全てのメッセージの読み上げを停止させることができます。
+
+## 使い方
+
+`/clear` コマンドを実行します。
+
+## 注意事項
+
+- このコマンドは、VCに参加しているユーザーのみが使用できます。

docs/for-users/commands/ignore.md

@@ -0,0 +1,41 @@
+# ignore
+
+無視ルールを設定します。無視対象のメッセージが投稿されても、読み上げられないようになります。
+
+## 使い方
+
+### 無視ルールの作成
+
+無視ルールを作成します。  
+このコマンドを使用すると、特定の文字列を含む、または完全一致するメッセージを読み上げないように設定できます。
+
+```text
+/ignore create <無視判定の種類> <無視する文字列>
+```
+
+- `<無視判定の種類>`: 無視判定の種類 (`Contains` または `Exact`)。`Contains` は指定した文字列を含む場合、`Exact` は完全に一致する場合に無視
+- `<無視する文字列>`: 含む場合、または完全一致する場合に無視する文字列
+
+### 無視の削除
+
+設定された無視ルールを削除します。
+
+```text
+/ignore delete <text>
+```
+
+**引数**:
+
+- `text`: 対象の無視する文字列
+
+### List
+
+設定されている無視ルールの一覧を表示します。
+
+```text
+/ignore list
+```
+
+## 注意事項
+
+- 無視ルールの設定は、サーバーごとに適用されます。他のサーバーで設定した無視ルールは影響しません。

docs/for-users/commands/index.md

@@ -0,0 +1,14 @@
+# コマンド一覧
+
+- [alias](alias.md): エイリアスに関する操作を行えます。
+- [clear](clear.md): 予定されているメッセージの読み上げを中止します。
+- [ignore](ignore.md): 無視ルールを設定します。無視対象のメッセージが投稿されても、読み上げられないようになります。
+- [join](join.md): Bot をボイスチャンネルに接続させます。
+- [leave](leave.md): ボイスチャンネルから退出します。
+- [parse](parse.md): 読み上げる文章の処理をテストします。
+- [reset-title](reset-title.md): ボイスチャンネルのチャンネル名（タイトル）をリセットします。
+- [save-title](save-title.md): 現在のチャンネル名をタイトルとして保存します。
+- [speak](speak.md): VCSpeaker として文章を読み上げます (デバッグ用)。
+- [title](title.md): ボイスチャンネルのチャンネル名を一時的に変更します。
+- [vcspeaker](vcspeaker.md): VCSpeaker を操作するためのコマンドです。
+- [voice](voice.md): 自分が投稿したメッセージの読み上げ音声の設定を行うためのコマンドです。

docs/for-users/commands/join.md

@@ -0,0 +1,20 @@
+# join
+
+Bot をボイスチャンネルに接続させます。
+
+## 使い方
+
+このコマンドは、Bot をボイスチャンネルに接続させます。AFK チャンネルへの接続は拒否されます。  
+Bot が既に他のボイスチャンネルにいる場合、そのチャンネルに移動します。
+
+```text
+/join [channel]
+```
+
+- `[channel]`: 参加する VC。指定しない場合、コマンドを実行したユーザーの現在のボイスチャンネルに接続します。
+
+## 注意事項
+
+- AFK チャンネルには接続できません
+- ユーザーがボイスチャンネルに参加していない場合、コマンドは失敗します
+- ボットが既にボイスチャンネルにいる場合、指定されたチャンネルに移動します

docs/for-users/commands/leave.md

@@ -0,0 +1,16 @@
+# leave
+
+ボイスチャンネルから退出します。
+
+## 使い方
+
+このコマンドは、Bot が現在参加しているボイスチャンネルから退出するために使用します。
+
+```text
+/leave
+/disconnect
+```
+
+## 注意事項
+
+- Bot がいずれかのボイスチャンネルに参加していない場合、エラーになります。

docs/for-users/commands/parse.md

@@ -0,0 +1,17 @@
+# parse
+
+読み上げる文章の処理をテストします。
+
+## 使い方
+
+ユーザーが指定したメッセージに対して、無視ルールの確認、エイリアスの適用、絵文字の置き換えなどの処理を行い、その結果を表示します。
+
+```text
+/parse <message>
+```
+
+- `<message>`: 処理をテストするメッセージ
+
+## 注意事項
+
+- メッセージに含まれる無視ルール、エイリアス、絵文字の置き換えは、サーバごとに設定されたルールに基づいて行われます。

docs/for-users/commands/reset-title.md

@@ -0,0 +1,19 @@
+# reset-title
+
+ボイスチャンネルのチャンネル名（タイトル）をリセットします。
+
+## 使い方
+
+指定されたボイスチャンネルのチャンネル名をリセットします。  
+ユーザーがボイスチャンネルにいる場合、そのチャンネルのチャンネル名がリセットされます。  
+指定されたチャンネルがない場合は、ユーザーが現在参加しているボイスチャンネルのチャンネル名がリセットされます。
+
+```text
+/reset-title [channel]
+```
+
+- `[channel]`: タイトルをリセットするチャンネル
+
+## 注意事項
+
+- チャンネル名が即時に更新されない場合があります。これは Discord のレートリミットによるもので、しばらく待つことで反映されます。

docs/for-users/commands/save-title.md

@@ -0,0 +1,28 @@
+# save-title
+
+現在のチャンネル名をタイトルとして保存します。
+
+## 使い方
+
+### 全てのチャンネルのタイトルを保存
+
+全てのボイスチャンネルのタイトルを保存し、成功した場合はそれぞれのチャンネル名と保存されたタイトルを表示します。
+
+```text
+/save-title all
+```
+
+### 指定されたチャンネルのタイトルを保存します
+
+指定されたボイスチャンネルのタイトルを保存し、成功した場合はそのチャンネル名と保存されたタイトルを表示します。
+
+```text
+/save-title channel [channel]
+```
+
+- `[channel]`: タイトルを保存するチャンネル。指定しない場合は、コマンドを実行したユーザーがいるチャンネルが選択されます。
+
+## 注意事項
+
+- サーバにおいて、一度でもタイトルを設定したことが無い場合、このコマンドは失敗します。
+  [title コマンド](title.md) を用いてタイトルを設定したうえで利用してください。

docs/for-users/commands/speak.md

@@ -0,0 +1,11 @@
+# speak
+
+VCSpeaker として文章を読み上げます (デバッグ用)。
+
+## 使い方
+
+```text
+/speak <text>
+```
+
+- `<text>`: 読み上げる文章

docs/for-users/commands/title.md

@@ -0,0 +1,25 @@
+# title
+
+ボイスチャンネルのチャンネル名を一時的に変更します。
+
+## 使い方
+
+タイトルを設定します。  
+指定したチャンネル、またはユーザーが現在参加しているボイスチャンネルのタイトルを変更します。  
+チャンネルから全員が退出すると、タイトルはリセットされます。
+
+```text
+/title <title> [channel]
+```
+
+- `<title>`: 設定するタイトル
+- `[channel]`: タイトルを設定するチャンネル。指定しない場合は、コマンドを実行したユーザーが現在参加しているボイスチャンネルが対象になります。
+
+## 注意事項
+
+- チャンネル名の変更にはレートリミットが適用されるため、名前が反映されるまでに時間がかかる場合があります。
+- チャンネルから全員が退出すると、設定したタイトルはリセットされます。
+
+## 関連するページ
+
+- [Title 機能について](../features/title.md)

docs/for-users/commands/vcspeaker.md

@@ -0,0 +1,37 @@
+# vcspeaker
+
+VCSpeaker を操作するためのコマンドです。  
+このコマンドを使用して、テキストチャンネルの読み上げ設定や、Bot の再起動などを行うことができます。
+
+## 使い方
+
+### restart
+
+VCSpeaker を再起動します。
+
+```text
+/vcspeaker restart
+```
+
+### settings
+
+VCSpeaker の設定を行います。この設定は、サーバごとに保存されます。
+
+```text
+/vcspeaker settings [channel] [prefix] [speaker] [emotion] [emotion-level] [pitch] [speed] [volume] [auto-join]
+```
+
+- `[channel]`: 読み上げるテキストチャンネル
+- `[prefix]`: チャットコマンドのプレフィックス
+- `[speaker]`: 話者
+- `[emotion]`: 感情
+- `[emotion-level]`: 感情レベル (1 から 4)
+- `[pitch]`: ピッチ (50% から 200%)
+- `[speed]`: 速度 (50% から 200%)
+- `[volume]`: 音量 (50% から 200%)
+- `[auto-join]`: ボイスチャンネルに自動で入退室するかどうか
+
+## 注意事項
+
+- `restart` サブコマンドを使用すると、Bot は即座に再起動されます。これにより、一時的に Bot が使用不可能になることがあります。
+- `settings` サブコマンドで設定を変更する際、指定しなかったオプションは現在の設定を維持します。全ての設定を一度に変更する必要はありません。