mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434)
* refactor(docs): rename directories to lowercase for PEP8 compliance - Developer-Guide → developer-guide - Getting-Started → getting-started - Reference → reference - Templates → templates - User-Guide → user-guide - User-Guide-jp → user-guide-jp - User-Guide-kr → user-guide-kr - User-Guide-zh → user-guide-zh This change aligns with Python PEP8 package naming conventions. All 43 files affected. * refactor: rename root documentation files to lowercase - CHANGELOG.md → changelog.md - CODE_OF_CONDUCT.md → code_of_conduct.md - CONTRIBUTING.md → contributing.md - SECURITY.md → security.md Aligns with Python package naming conventions (PEP8). README files remain uppercase as per convention. * refactor: move documentation files to docs/ for cleaner root Moved OSS standard files to docs/: - CHANGELOG.md → docs/CHANGELOG.md - CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md - CONTRIBUTING.md → docs/CONTRIBUTING.md - SECURITY.md → docs/SECURITY.md Root now contains only essential files: ✓ README files (表紙: en, ja, kr, zh) ✓ LICENSE (法的要件) ✓ Build configs (pyproject.toml, setup.py, MANIFEST.in) ✓ VERSION Rationale: Cleaner root structure following modern Python project conventions. All detailed documentation consolidated in docs/ directory. * refactor: update documentation links after restructure Auto-updated internal documentation links to reflect new structure: - docs/ subdirectories now lowercase (PEP8) - Root files moved to docs/ - All cross-references updated This commit includes linter-generated link updates. * chore(docs): keep OSS-standard uppercase root files (CHANGELOG, CODE_OF_CONDUCT, CONTRIBUTING, SECURITY) * chore(docs): remove duplicated PR docs from repo root (moved under docs) * docs: rename pm-agent-implementation-status.md -> PM_AGENT.md for clarity * docs: update links to PM_AGENT.md after rename --------- Co-authored-by: kazuki <kazuki@kazukinoMacBook-Air.local>
This commit is contained in:
@@ -23,12 +23,12 @@
|
||||
1. ドキュメント読み込み:
|
||||
優先順位:
|
||||
1. タスク管理ドキュメント → 進捗確認
|
||||
- docs/Development/tasks/current-tasks.md
|
||||
- docs/development/tasks/current-tasks.md
|
||||
- 前回どこまでやったか
|
||||
- 次に何をすべきか
|
||||
|
||||
2. アーキテクチャドキュメント → 仕組み理解
|
||||
- docs/Development/architecture-*.md
|
||||
- docs/development/architecture-*.md
|
||||
- このプロジェクトの構造
|
||||
- インストールフロー
|
||||
- コンポーネント連携
|
||||
@@ -36,7 +36,7 @@
|
||||
3. 禁止事項・ルール → 制約確認
|
||||
- CLAUDE.md(グローバル)
|
||||
- PROJECT/CLAUDE.md(プロジェクト固有)
|
||||
- docs/Development/constraints.md
|
||||
- docs/development/constraints.md
|
||||
|
||||
4. 過去の学び → 同じミスを防ぐ
|
||||
- docs/mistakes/ (失敗記録)
|
||||
@@ -88,7 +88,7 @@
|
||||
```yaml
|
||||
1. 改善仮説作成:
|
||||
# このプロジェクト内で(Git管理)
|
||||
File: docs/Development/hypothesis-YYYY-MM-DD.md
|
||||
File: docs/development/hypothesis-YYYY-MM-DD.md
|
||||
|
||||
内容:
|
||||
- 現状の問題点
|
||||
@@ -127,7 +127,7 @@
|
||||
- quality-engineer: テスト設計
|
||||
|
||||
2. 実装記録:
|
||||
File: docs/Development/experiment-YYYY-MM-DD.md
|
||||
File: docs/development/experiment-YYYY-MM-DD.md
|
||||
|
||||
内容:
|
||||
- 試行錯誤の記録
|
||||
@@ -194,7 +194,7 @@
|
||||
- チェックリスト
|
||||
|
||||
3. タスク更新:
|
||||
File: docs/Development/tasks/current-tasks.md
|
||||
File: docs/development/tasks/current-tasks.md
|
||||
|
||||
内容:
|
||||
- 完了したタスク
|
||||
@@ -292,7 +292,7 @@ docs/
|
||||
│ └── experiment-*.md # 実験記録
|
||||
├── patterns/ # 成功パターン(清書後)
|
||||
├── mistakes/ # 失敗記録と防止策
|
||||
└── (既存のUser-Guide等)
|
||||
└── (既存のuser-guide等)
|
||||
```
|
||||
|
||||
---
|
||||
@@ -335,7 +335,7 @@ docs/
|
||||
|
||||
このドキュメント作成後:
|
||||
1. 既存のインストールロジック理解(setup/components/)
|
||||
2. タスク管理ドキュメント作成(docs/Development/tasks/)
|
||||
2. タスク管理ドキュメント作成(docs/development/tasks/)
|
||||
3. PM Agent実装修正(このワークフローを実際に実装)
|
||||
|
||||
このドキュメント自体が**PM Agentの憲法**となる。
|
||||
|
||||
Reference in New Issue
Block a user