📖 Fine tuning

docs/HowToUseDocFX.md

@@ -0,0 +1,7 @@
+# ローカル環境でドキュメントをプレビューする方法
+リポジトリルートで、
+```
+docfx docs\docfx.json --serve
+```
+
+を実行する。

docs/docfx.json

@@ -36,9 +36,12 @@
       "modern"
     ],
     "globalMetadata": {
-      "_appName": "SoundMaker API Reference",
-      "_appTitle": "SoundMaker API Reference",
+      "_appName": "SoundMaker Documentation",
+      "_appTitle": "SoundMaker Documentation",
+      "_appFooter": "SoundMaker © 2022-2024",
       "_enableSearch": true,
+      "_appLogoPath": "images/favicon.png",
+      "_appFaviconPath": "images/favicon.png",
       "pdf": false
     }
   }

docs/markdowns/introduction.md

@@ -1 +1,2 @@
-# Introduction
+# イントロダクション
+ここではSoundMakerの使用例をプログラムを示しながら紹介します。

docs/markdowns/migrate-to-ver-3.md

@@ -0,0 +1,28 @@
+# Ver 3.0.0への移行ガイド
+
+SoundMaker Ver 3.0.0への移行に関して、以下のガイドラインに従ってください。メジャーバージョンアップにより、破壊的変更が含まれていますのでご注意ください。
+
+## .NET 7以前を利用している場合は.NET 8以降へアップデートする
+.NET 6のサポート終了に伴い、SoundMakerも.NET 8へ移行しました。.NET 8へのアップデートは以下の手順で行います：
+1. **.NET SDKのインストール**: 最新の.NET 8 SDKを[公式サイト](https://dotnet.microsoft.com/download/dotnet/8.0)からダウンロードしてインストールします。
+2. **プロジェクトファイルの更新**: 各プロジェクトの`TargetFramework`を`.NET 8`に更新します。例えば、`.csproj`ファイルで以下のように変更します：
+    ```xml
+    <TargetFramework>net8.0</TargetFramework>
+    ```
+3. **依存関係の更新**: `.NET 8`に対応するライブラリやパッケージのバージョンを確認し、必要に応じてアップデートします。
+
+## ushort[]型からshort[]型を利用するように変更する
+音声波形は符号付き整数を利用することが一般的なので、Ver 3.0.0では`ushort`型から`short`型に変更しました。以下の手順で対応します：
+**コードの修正**: `ushort[]`型を使用している箇所をすべて`short[]`型に変更します。例えば、
+```csharp
+// 旧コード
+ushort[] sample = [32767];
+
+// 新コード
+short[] sample = [32767];
+```
+
+## 廃止機能を利用しない
+Ver 3.0.0以前に`Obsolete`属性がついたメソッドやプロパティは削除されました。これに対応するためには、以下の手順を行います：
+1. **コードのチェック**: `Obsolete`属性が付与されたメソッドやプロパティを使用している箇所を確認します。これらはコンパイラ警告として表示されることが多いです。
+2. **代替機能の利用**: `Obsolete`となった機能の代替となるメソッドやプロパティを使用します。削除された機能に関する詳細は、削除を行ったプルリクエストを参照してください：[削除を行ったプルリクエスト](https://github.com/AutumnSky1010/SoundMaker/pull/29/files)

docs/markdowns/toc.yml

@@ -1,4 +1,25 @@
-- name: Introduction
+- name: イントロダクション
   href: introduction.md
-- name: Getting Started
-  href: getting-started.md
+- name: 基本的な使い方
+  items:
+  - name: 最初のコード
+    href: start/getting-started.md
+  - name: 利用できるフォーマット
+    href: start/format.md
+  - name: 周波数を指定し、音声波形を生成する
+    href: start/gen/frequency.md
+  - name: 音楽知識から波形を生成する
+    items:
+      - name: チャンネルベースAPI
+        href: start/gen/channel-base-api.md
+      - name: トラックベースAPI
+        href: start/gen/track-base-api.md
+  - name: WAV出力
+    href: start/wav.md
+- name: Ver 3.0.0への移行
+  href: migrate-to-ver-3.md
+- name: SMSCフォーマット
+  items:
+    - name: SMSCフォーマットとは？
+      href: smsc/what-is-the-smsc.md
+    - name: SMSCシリアライズ・デシリアライズ

docs/toc.yml

@@ -1,4 +1,4 @@
-- name: Docs
+- name: ドキュメント
   href: markdowns/
-- name: API
+- name: APIリファレンス
   href: api/