Skip to content

Commit b7af3b2

Browse files
committed
docs: Markdown内のファイル参照にジャンプリンクを追加
1 parent 1c20e34 commit b7af3b2

3 files changed

Lines changed: 67 additions & 67 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Developer-focused details (architecture, CI, tests, implementation cautions):
1010

1111
| Need | Document |
1212
| --- | --- |
13-
| Product overview, setup, usage, and configuration | `README.md` |
13+
| Product overview, setup, usage, and configuration | [README.md](README.md) |
1414
| Runtime architecture, execution flow, DI scopes, and implementation guardrails | [doc/DEVELOPER_GUIDE.md](doc/DEVELOPER_GUIDE.md) |
1515
| Test strategy, local test commands, coverage, and isolation rules | [doc/TESTING_GUIDE.md](doc/TESTING_GUIDE.md) |
16-
| Generated API reference from XML documentation comments | [api/index.md](api/index.md) via `docfx.json` |
16+
| Generated API reference from XML documentation comments | [api/index.md](api/index.md) via [docfx.json](docfx.json) |
1717

1818
## Requirements
1919

@@ -58,7 +58,7 @@ dotnet tool install --global ilspycmd
5858

5959
## Usage
6060

61-
1. Place `config.json` next to the executable.
61+
1. Place [`config.json`](config.json) next to the executable.
6262
2. Run with arguments:
6363
- old folder absolute path
6464
- new folder absolute path
@@ -76,8 +76,8 @@ Main output:
7676

7777
## Runtime Composition
7878

79-
- `Program.cs` is intentionally thin and only resolves `ProgramRunner`.
80-
- `ProgramRunner` validates arguments, loads `config.json`, builds a per-run DI container, and executes the diff/report pipeline.
79+
- [`Program.cs`](Program.cs) is intentionally thin and only resolves `ProgramRunner`.
80+
- `ProgramRunner` validates arguments, loads [`config.json`](config.json), builds a per-run DI container, and executes the diff/report pipeline.
8181
- `ProgramRunner` also owns aggregated end-of-run console warnings such as `MD5Mismatch` and timestamp-regression notices.
8282
- `DiffExecutionContext` carries run-specific paths and network-mode decisions.
8383
- `FolderDiffService` uses `IFileSystemService` for discovery/output I/O and `FileDiffService` uses `IFileComparisonService` for hash, text, and chunk-read operations, which keeps permission and disk-failure paths unit-testable without changing runtime behavior.
@@ -113,9 +113,9 @@ Important details:
113113
- Text files may use different internal strategies depending on size and runtime mode. If chunk-parallel comparison for a large local file throws, the run logs a warning and retries with sequential text comparison.
114114
- If IL comparison itself fails, the run stops instead of silently falling back to a weaker comparison.
115115

116-
## Configuration (`config.json`)
116+
## Configuration ([`config.json`](config.json))
117117

118-
Place `config.json` next to the executable. Example:
118+
Place [`config.json`](config.json) next to the executable. Example:
119119

120120
```json
121121
{
@@ -290,10 +290,10 @@ CI also generates the same site and uploads it as the `DocumentationSite` artifa
290290

291291
| 見たい内容 | ドキュメント |
292292
| --- | --- |
293-
| 製品概要、導入、使い方、設定 | `README.md` |
293+
| 製品概要、導入、使い方、設定 | [README.md](README.md) |
294294
| 実行時アーキテクチャ、実行フロー、DI スコープ、実装上の注意点 | [doc/DEVELOPER_GUIDE.md](doc/DEVELOPER_GUIDE.md) |
295295
| テスト戦略、ローカル実行コマンド、カバレッジ、分離ルール | [doc/TESTING_GUIDE.md](doc/TESTING_GUIDE.md) |
296-
| XML ドキュメントコメントから生成する API リファレンス | [api/index.md](api/index.md) と `docfx.json` |
296+
| XML ドキュメントコメントから生成する API リファレンス | [api/index.md](api/index.md) と [docfx.json](docfx.json) |
297297

298298
## 必要環境
299299

@@ -342,7 +342,7 @@ dotnet tool install --global ilspycmd
342342

343343
## 使い方
344344

345-
1. 実行ファイルと同じ場所に `config.json` を配置します。
345+
1. 実行ファイルと同じ場所に [`config.json`](config.json) を配置します。
346346
2. 次の引数で実行します。
347347
- 旧フォルダ(比較元)の絶対パス
348348
- 新フォルダ(比較先)の絶対パス
@@ -360,8 +360,8 @@ dotnet run "/Users/UserA/workspace/old" "/Users/UserA/workspace/new" "YYYYMMDD"
360360

361361
## 実行時構成
362362

363-
- `Program.cs` は薄いエントリーポイントで、`ProgramRunner` の解決だけを行います。
364-
- `ProgramRunner` が引数検証、`config.json` 読込、実行単位 DI コンテナ生成、差分/レポート処理の実行を担います。
363+
- [`Program.cs`](Program.cs) は薄いエントリーポイントで、`ProgramRunner` の解決だけを行います。
364+
- `ProgramRunner` が引数検証、[`config.json`](config.json) 読込、実行単位 DI コンテナ生成、差分/レポート処理の実行を担います。
365365
- `ProgramRunner` は `MD5Mismatch` や更新日時逆転のような集約後の終了時コンソール警告も担当します。
366366
- `DiffExecutionContext` が実行ごとのパスやネットワークモード判定を保持します。
367367
- `FolderDiffService` は列挙/出力系 I/O を `IFileSystemService`、`FileDiffService` はハッシュ/テキスト/チャンク読み出し系 I/O を `IFileComparisonService` に委譲しており、権限エラーやディスク系失敗の経路も実ファイルなしでユニットテストできます。
@@ -397,7 +397,7 @@ flowchart TD
397397
- テキスト比較の内部実装はファイルサイズや実行モードで変わることがあります。大きいローカルファイルの並列比較で例外が出た場合は warning を記録し、逐次比較へフォールバックします。
398398
- IL 比較そのものに失敗した場合は、弱い比較へ黙って落とさず、その実行全体を停止します。
399399

400-
## 設定(`config.json`)
400+
## 設定([`config.json`](config.json))
401401

402402
実行ファイルと同じディレクトリに配置します。例:
403403

0 commit comments

Comments
 (0)