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:
@@ -8,7 +8,7 @@
|
||||
## 🔥 High Priority (This Week: 2025-10-14 ~ 2025-10-20)
|
||||
|
||||
### Phase 1: Documentation Structure
|
||||
- [x] Create docs/Development/ directory
|
||||
- [x] Create docs/development/ directory
|
||||
- [x] Write ARCHITECTURE.md
|
||||
- [x] Write ROADMAP.md
|
||||
- [ ] Write TASKS.md (this file)
|
||||
@@ -21,7 +21,7 @@
|
||||
- [x] Design PDCA Cycle
|
||||
- [x] Update Commands/pm.md
|
||||
- [x] Update Agents/pm-agent.md
|
||||
- [x] Create pm-agent-implementation-status.md
|
||||
- [x] Create PM_AGENT.md
|
||||
- [ ] Commit PM Agent Mode changes
|
||||
|
||||
---
|
||||
@@ -33,7 +33,7 @@
|
||||
- [ ] Implement superclaude/Core/pdca_engine.py
|
||||
- [ ] Implement superclaude/Core/memory_ops.py
|
||||
- [ ] Write unit tests for PM Agent core
|
||||
- [ ] Update User-Guide documentation
|
||||
- [ ] Update user-guide documentation
|
||||
|
||||
### Testing & Validation
|
||||
- [ ] Create test suite for session_lifecycle
|
||||
@@ -84,8 +84,8 @@
|
||||
### 2025-10-14
|
||||
- [x] Salvaged PM Agent mode changes from ~/.claude
|
||||
- [x] Cleaned up ~/.claude git repository
|
||||
- [x] Created pm-agent-implementation-status.md
|
||||
- [x] Created docs/Development/ directory
|
||||
- [x] Created PM_AGENT.md
|
||||
- [x] Created docs/development/ directory
|
||||
- [x] Wrote ARCHITECTURE.md
|
||||
- [x] Wrote ROADMAP.md
|
||||
- [x] Wrote TASKS.md
|
||||
|
||||
Reference in New Issue
Block a user