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:
28
README-zh.md
28
README-zh.md
@@ -275,55 +275,55 @@ pip install --break-system-packages SuperClaude
|
||||
<tr>
|
||||
<td valign="top">
|
||||
|
||||
- 📝 [**快速开始指南**](docs/Getting-Started/quick-start.md)
|
||||
- 📝 [**快速开始指南**](docs/getting-started/quick-start.md)
|
||||
*快速上手使用*
|
||||
|
||||
- 💾 [**安装指南**](docs/Getting-Started/installation.md)
|
||||
- 💾 [**安装指南**](docs/getting-started/installation.md)
|
||||
*详细的安装说明*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🎯 [**命令参考**](docs/User-Guide-zh/commands.md)
|
||||
- 🎯 [**命令参考**](docs/user-guide-zh/commands.md)
|
||||
*全部21个斜杠命令*
|
||||
|
||||
- 🤖 [**智能体指南**](docs/User-Guide-zh/agents.md)
|
||||
- 🤖 [**智能体指南**](docs/user-guide-zh/agents.md)
|
||||
*14个专业智能体*
|
||||
|
||||
- 🎨 [**行为模式**](docs/User-Guide-zh/modes.md)
|
||||
- 🎨 [**行为模式**](docs/user-guide-zh/modes.md)
|
||||
*5种自适应模式*
|
||||
|
||||
- 🚩 [**标志指南**](docs/User-Guide-zh/flags.md)
|
||||
- 🚩 [**标志指南**](docs/user-guide-zh/flags.md)
|
||||
*控制行为参数*
|
||||
|
||||
- 🔧 [**MCP服务器**](docs/User-Guide-zh/mcp-servers.md)
|
||||
- 🔧 [**MCP服务器**](docs/user-guide-zh/mcp-servers.md)
|
||||
*6个服务器集成*
|
||||
|
||||
- 💼 [**会话管理**](docs/User-Guide-zh/session-management.md)
|
||||
- 💼 [**会话管理**](docs/user-guide-zh/session-management.md)
|
||||
*保存和恢复状态*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- 🏗️ [**技术架构**](docs/Developer-Guide/technical-architecture.md)
|
||||
- 🏗️ [**技术架构**](docs/developer-guide/technical-architecture.md)
|
||||
*系统设计详情*
|
||||
|
||||
- 💻 [**贡献代码**](docs/Developer-Guide/contributing-code.md)
|
||||
- 💻 [**贡献代码**](docs/developer-guide/contributing-code.md)
|
||||
*开发工作流程*
|
||||
|
||||
- 🧪 [**测试与调试**](docs/Developer-Guide/testing-debugging.md)
|
||||
- 🧪 [**测试与调试**](docs/developer-guide/testing-debugging.md)
|
||||
*质量保证*
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
|
||||
- ✨ [**最佳实践**](docs/Reference/quick-start-practices.md)
|
||||
- ✨ [**最佳实践**](docs/reference/quick-start-practices.md)
|
||||
*专业技巧和模式*
|
||||
|
||||
- 📓 [**示例手册**](docs/Reference/examples-cookbook.md)
|
||||
- 📓 [**示例手册**](docs/reference/examples-cookbook.md)
|
||||
*实际应用示例*
|
||||
|
||||
- 🔍 [**故障排除**](docs/Reference/troubleshooting.md)
|
||||
- 🔍 [**故障排除**](docs/reference/troubleshooting.md)
|
||||
*常见问题和修复*
|
||||
|
||||
</td>
|
||||
|
||||
Reference in New Issue
Block a user