[Phase 9] 包括的なドキュメント整備とREADME更新

[yellow-seed]

概要

移行完了後の最終的なドキュメント整備とREADMEの更新を行います。

依存関係

• [Phase 1] ディレクトリ構造の再編成とhomeディレクトリの作成 #3〜[Phase 6] Brewfileの移行とmacOS Homebrew管理の整備 #8 が完了していること（全ての基本構造が整っている）

背景

新しいディレクトリ構造とテスト可能なdotfiles管理について、包括的なドキュメントを作成し、利用方法を明確にします。

タスク

README.mdの大幅更新

• プロジェクト概要セクションの追加

  • テスト可能なdotfiles管理のアプローチ説明
  • 参考記事へのリンク

• ディレクトリ構造の説明を追加

## Directory Structure

.
├── .chezmoiroot # chezmoi source directory marker
├── home/ # Dotfiles managed by chezmoi
│ ├── .chezmoi.toml.tmpl
│ ├── .chezmoiignore
│ ├── dot_Brewfile
│ ├── dot_config/
│ ├── dot_gitconfig
│ ├── dot_gitignore_global
│ └── dot_zshrc
├── install/ # Installation scripts (testable)
│ ├── template.sh
│ ├── common/ # Common scripts
│ ├── macos/ # macOS specific scripts
│ └── ubuntu/ # Ubuntu specific scripts
├── tests/ # Automated tests with Bats
│ ├── install/
│ └── files/
├── scripts/ # Utility scripts
│ ├── run_tests.sh
│ ├── run_unit_test.sh
│ └── benchmark.sh
└── setup.sh # One-liner setup wrapper

• セットアップ手順の更新

## Quick Start

### New Machine Setup
```bash
# One-liner installation
sh -c "$(curl -fsLS get.chezmoi.io)" -- init --apply yellow-seed

Manual Setup

# 1. Install chezmoi
brew install chezmoi  # macOS
# or
sh -c "$(curl -fsLS get.chezmoi.io)"  # Linux

# 2. Initialize and apply dotfiles
chezmoi init --apply yellow-seed

# 3. Install packages (macOS)
bash install/macos/common/brewfile.sh

# 4. Install packages (Ubuntu)
bash install/ubuntu/common/misc.sh

- [ ] 開発・テストセクションの追加
```markdown
## Development

### Running Tests Locally
```bash
# Install Bats
brew install bats-core  # macOS
sudo apt-get install bats  # Ubuntu

# Run all tests
bats tests/install/

# Run specific test
bats tests/install/macos/common/brew.bats

Adding New Tools

1. Create installation script in install/<platform>/
2. Create test file in tests/install/<platform>/
3. Run tests locally
4. Submit PR

- [ ] CI/CDセクションの追加
  - テストワークフローの説明
  - カバレッジレポートへのリンク
  - ベンチマーク結果へのリンク

### 個別ドキュメントの作成
- [ ] `docs/CONTRIBUTING.md` を作成
  - 新しいツールの追加方法
  - テストの書き方
  - PRの作成方法

- [ ] `docs/ARCHITECTURE.md` を作成
  - アーキテクチャの設計思想
  - 各ディレクトリの役割
  - スクリプトのパターン

- [ ] `docs/TESTING.md` を作成
  - テスト戦略の詳細
  - Batsの使い方
  - CI/CDパイプライン

### バッジの追加
- [ ] README.mdにバッジを追加
```markdown
[![Test](https://github.com/yellow-seed/dotfiles/workflows/Test/badge.svg)](https://github.com/yellow-seed/dotfiles/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/yellow-seed/dotfiles/branch/main/graph/badge.svg)](https://codecov.io/gh/yellow-seed/dotfiles)

期待される結果

• 包括的で分かりやすいドキュメント
• 新規ユーザーがすぐに使い始められる
• 開発者がコントリビュートしやすい環境

参考

• shunk031/dotfiles のREADME構成
• 参考記事全体の内容

注意事項

• ドキュメントは継続的に更新していく必要があります
• 実際のユーザーからのフィードバックを反映させましょう