mirror of https://github.com/SuperClaude-Org/SuperClaude_Framework.git synced 2025-12-17 09:46:06 +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>

2025-10-15 21:07:39 +05:30

1.7 KiB

Raw Blame History

SuperClaude Common Issues - Quick Reference 🚀

Problem Solving Guide: Most frequent issues with practical solutions.

Top 5 Quick Fixes (90% of Issues)

1. Commands Not Working in Claude Code ⚡

Problem: /sc:brainstorm doesn't work
Solution: Restart Claude Code completely
Test: /sc:brainstorm "test" should ask questions

2. Installation Verification

python3 -m SuperClaude --version    # Should show 4.1.5

# If not working:
# For pipx users
pipx upgrade SuperClaude

# For pip users
pip install --upgrade SuperClaude

# Then reinstall
python3 -m SuperClaude install

3. Permission Issues

# Permission denied / PEP 668 errors:
# Option 1: Use pipx (recommended)
pipx install SuperClaude

# Option 2: Use pip with --user
pip install --user SuperClaude

# Option 3: Fix permissions
sudo chown -R $USER ~/.claude

4. MCP Server Issues

/sc:analyze . --no-mcp              # Test without MCP servers
node --version                      # Check Node.js 16+ if needed

5. Component Missing

python3 -m SuperClaude install --components core commands agents modes --force

Platform-Specific Issues

Windows:

set CLAUDE_CONFIG_DIR=%USERPROFILE%\.claude
python -m SuperClaude install --install-dir "%CLAUDE_CONFIG_DIR%"

macOS:

brew install python3 node
pip3 install SuperClaude

Linux:

sudo apt install python3 python3-pip nodejs
pip3 install SuperClaude

Verification Checklist

python3 -m SuperClaude --version returns 4.1.5
/sc:brainstorm "test" works in Claude Code
SuperClaude install --list-components shows components

When Quick Fixes Don't Work

See Troubleshooting Guide for advanced diagnostics.

1.7 KiB Raw Blame History