📋 ドキュメント一覧
🚀 利用者向け
- product-overview.md - プロダクト概要と価値提案
- local-development.md - ローカル開発環境セットアップ
- configuration.md - 設定・カスタマイズガイド
- deployment.md - デプロイメント方法（各プラットフォーム対応）
🏗️ 開発者向け
- architecture.md - システム全体設計とアーキテクチャ概要
- features.md - 機能詳細と使用方法
- security.md - セキュリティガイドとベストプラクティス
🔧 技術仕様
- API_SPECIFICATION.md - REST API仕様とエンドポイント詳細
- github-integration.md - GitHub API統合の技術実装
🚀 基本的な使用方法
GitHub Actionとしての利用については、メインのREADME.mdをご覧ください。
最低限の設定でBeaverを導入:
- uses: nyasuto/beaver@v1
🗺️ ドキュメントナビゲーション
初回利用者
- product-overview.md でBeaverの全体像を把握
- README.md でGitHub Actionの導入方法を確認
開発者・カスタマイザー
- local-development.md でローカル環境をセットアップ
- architecture.md で設計思想を理解
- configuration.md でカスタマイズ方法を学習
- features.md で詳細機能を把握
運用・デプロイ担当者
- deployment.md で各プラットフォームへのデプロイ方法を確認
- security.md でセキュリティ要件を理解
- configuration.md で運用設定を調整
API開発者
- API_SPECIFICATION.md でエンドポイント仕様を確認
- github-integration.md でGitHub API連携を理解