External/SuperClaude
1
0
Fork 0
mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-29 16:16:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(docs): normalize documentation naming to lowercase for PEP8 compliance (#434)

Browse Source 
* 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:
kazuki nakai
2025-10-16 00:37:39 +09:00
committed by GitHub
parent 7c14a31bc3
commit d5dfd7da21
60 changed files with 836 additions and 886 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/README.md
View File

@@ -12,7 +12,7 @@
## 🚀 Quick Start (5 Minutes)
**New Users**: [Quick Start Guide →](Getting-Started/quick-start.md)
**New Users**: [Quick Start Guide →](getting-started/quick-start.md)
```bash
# Recommended for Linux/macOS
pipx install SuperClaude && SuperClaude install
@@ -23,37 +23,37 @@ pip install SuperClaude && SuperClaude install
# Then try: /sc:brainstorm "web app idea" in Claude Code
```
**Having Issues**: [Quick Fixes →](Reference/common-issues.md) | [Troubleshooting →](Reference/troubleshooting.md)
**Having Issues**: [Quick Fixes →](reference/common-issues.md) | [Troubleshooting →](reference/troubleshooting.md)
## 📚 Documentation Structure
### 🌱 Start Here (New Users)
| Guide | Purpose |
|-------|---------|
| **[Quick Start](Getting-Started/quick-start.md)** | Setup and first commands |
| **[Installation](Getting-Started/installation.md)** | Detailed setup instructions |
| **[Commands Guide](User-Guide/commands.md)** | All 21 `/sc:` commands |
| **[Quick Start](getting-started/quick-start.md)** | Setup and first commands |
| **[Installation](getting-started/installation.md)** | Detailed setup instructions |
| **[Commands Guide](user-guide/commands.md)** | All 21 `/sc:` commands |
### 🌿 Daily Usage (Regular Users)
| Guide | Purpose | Use For |
|-------|---------|---------|
| **[Commands Guide](User-Guide/commands.md)** | Master all `/sc:` commands | Daily development |
| **[Agents Guide](User-Guide/agents.md)** | 14 domain specialists (`@agent-*`) | Expert assistance |
| **[Flags Guide](User-Guide/flags.md)** | Command behavior modification | Optimization |
| **[Modes Guide](User-Guide/modes.md)** | 5 behavioral modes | Workflow optimization |
| **[Commands Guide](user-guide/commands.md)** | Master all `/sc:` commands | Daily development |
| **[Agents Guide](user-guide/agents.md)** | 14 domain specialists (`@agent-*`) | Expert assistance |
| **[Flags Guide](user-guide/flags.md)** | Command behavior modification | Optimization |
| **[Modes Guide](user-guide/modes.md)** | 5 behavioral modes | Workflow optimization |
### 🌲 Reference & Advanced (Power Users)
| Guide | Purpose | Use For |
|-------|---------|---------|
| **[Troubleshooting](Reference/troubleshooting.md)** | Problem resolution | When things break |
| **[Examples Cookbook](Reference/examples-cookbook.md)** | Practical usage patterns | Learning workflows |
| **[MCP Servers](User-Guide/mcp-servers.md)** | 6 enhanced capabilities | Advanced features |
| **[Troubleshooting](reference/troubleshooting.md)** | Problem resolution | When things break |
| **[Examples Cookbook](reference/examples-cookbook.md)** | Practical usage patterns | Learning workflows |
| **[MCP Servers](user-guide/mcp-servers.md)** | 6 enhanced capabilities | Advanced features |
### 🔧 Development & Contributing
| Guide | Purpose | Audience |
|-------|---------|----------|
| **[Technical Architecture](Developer-Guide/technical-architecture.md)** | System design | Contributors |
| **[Contributing](Developer-Guide/contributing-code.md)** | Development workflow | Developers |
| **[Technical Architecture](developer-guide/technical-architecture.md)** | System design | Contributors |
| **[Contributing](developer-guide/contributing-code.md)** | Development workflow | Developers |
## 🔑 Key Concepts
@@ -112,10 +112,10 @@ User Input → Claude Code → Reads SuperClaude Context → Modified Behavior
## 🆘 Getting Help
**Quick Issues** (< 2 min): [Common Issues →](Reference/common-issues.md)
**Complex Problems**: [Full Troubleshooting Guide →](Reference/troubleshooting.md)
**Installation Issues**: [Installation Guide →](Getting-Started/installation.md)
**Command Help**: [Commands Guide →](User-Guide/commands.md)
**Quick Issues** (< 2 min): [Common Issues →](reference/common-issues.md)
**Complex Problems**: [Full Troubleshooting Guide →](reference/troubleshooting.md)
**Installation Issues**: [Installation Guide →](getting-started/installation.md)
**Command Help**: [Commands Guide →](user-guide/commands.md)
**Community Support**: [GitHub Discussions](https://github.com/SuperClaude-Org/SuperClaude_Framework/discussions)
## 🤔 Common Misconceptions Clarified