Merged
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Restructure README for clarity: hero section, problem statement, quick start, concise usage table, and feature summary - Extract detailed docs to separate files: - docs/configuration.md: full config reference - docs/reserved-ports.md: reserved port behavior and examples - docs/network-conflict.md: subnet conflict resolution details - Remove Directory Structure section (internal detail) - Replace verbose Japanese log output with concise English table example - Follow lazydocker-style minimal & scannable structure Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove auto-cleanup claim (not implemented) - Remove clean command from command table (stub only) - Clarify that gopose generates override.yml but does not run docker compose up - Update output example and descriptions accordingly Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
READMEを著名OSS(lazydocker, fzf, ripgrep)のパターンを参考に再構成。情報過多だったREADME(約490行)
をコンパクト(約150行)にし、詳細ドキュメントをdocs/に分離。併せて、未実装機能(Auto-cleanup、docker
compose up実行)の記載を削除し、実装と一致する内容に修正。
変更内容
docs/configuration.md: 設定ファイルの全オプションリファレンスdocs/reserved-ports.md: 予約ポートの動作と設定例docs/network-conflict.md: ネットワーク競合回避の詳細docs/plans/2026-02-17-readme-improvement-design.md: 設計ドキュメントを追加期待すること
動作確認