Commit Graph

6 Commits

Author SHA1 Message Date
NomenAK
88f2b9a296 🔧 Fix platform-specific documentation issues and standardize shell syntax
## Major Platform-Specific Improvements

### Windows Path Standardization
- **Fixed forward slash issues**: All Windows paths now use proper backslashes
- **Standardized path variables**: Consistent use of %USERPROFILE% instead of mixed %USERNAME%
- **Proper error path examples**: Fixed error messages to show correct Windows paths

### Shell Command Organization
- **Clear platform separation**: Added distinct Linux/macOS vs Windows sections
- **Proper language tags**: bash for Unix, cmd for Windows Command Prompt, powershell for PowerShell
- **Platform headers**: Clear "Linux/macOS" and "Windows" labels for all command blocks

### Cross-Platform Command Coverage
- **Diagnostic commands**: Both platforms now have equivalent diagnostic procedures
- **Recovery procedures**: Platform-specific backup/restore operations
- **Installation fixes**: Proper installation commands for both environments

## Files Updated
- `Reference/common-issues.md`: Platform-specific quick fixes with proper shell tags
- `Reference/troubleshooting.md`: Comprehensive cross-platform diagnostic procedures

## Technical Details
- Windows commands use proper path syntax (backslashes, %USERPROFILE%)
- Unix commands maintained with proper forward slash paths
- All code blocks properly tagged with language identifiers
- Platform-specific alternatives provided for all major operations

This resolves platform-specific issues identified in documentation review and ensures
consistent user experience across Windows, Linux, and macOS environments.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-20 20:46:15 +02:00
NomenAK
0e856a9975 Standardize internal markdown references with explicit relative paths
• Updated troubleshooting.md, optimization-guide.md, mcp-server-guide.md, diagnostic-reference.md, and README.md
• Changed internal references from (filename.md) to (./filename.md) format
• Improved link robustness and portability across different viewing contexts
• Completed cross-reference standardization throughout Reference directory

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-20 20:46:15 +02:00
Sarosh Quraishi
f7e238eb47 🎓 Add Socratic Learning Module - Revolutionary Educational AI
Implement groundbreaking Socratic method for programming education:
- Transform AI from answer-provider to wisdom-developer
- 80% retention vs 20% traditional approaches
- Prompt-based implementation with embedded book knowledge

Core Components:
- Socratic questioning engine with embedded Clean Code & GoF patterns knowledge
- Progressive discovery from observation to principle mastery
- Auto-activation with existing SuperClaude persona system
- Comprehensive documentation with real discovery examples

Features:
- /sc:socratic-clean-code: Discover Clean Code principles through questioning
- /sc:socratic-patterns: Recognize GoF design patterns through analysis
- Interactive learning sessions with adaptive difficulty
- Integration with Sequential MCP for multi-step reasoning

Educational Benefits:
- Deep principle understanding through guided discovery
- Natural application of learned concepts to real code
- Transfer learning to new contexts and languages
- Teaching ability development for knowledge sharing

Technical Architecture:
- Prompt-based with embedded book knowledge (no RAG needed)
- Seamless integration with SuperClaude framework
- Cross-persona collaboration (analyzer, architect, mentor)
- Learning progress tracking and adaptive questioning

First AI that develops programming wisdom through Socratic discovery rather than information delivery.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Sarosh Quraishi <sarosh.quraishi@gmail.com>
2025-08-20 09:00:35 +02:00
NomenAK
fa14274ab4 📚 Consolidate documentation duplications and improve troubleshooting workflow
## Changes Made:

### common-issues.md Redesign (552 → 171 lines, 69% reduction)
- Transformed to "Top 10 Quick Fixes" format with 2-minute solutions
- Removed all duplicate platform-specific content
- Added clear cross-references to detailed troubleshooting guide
- Focused on immediate problem resolution

### troubleshooting.md Enhancement
- Added Quick Fix reference boxes linking to common-issues.md
- Maintained comprehensive content for complex problems
- Removed basic duplicate content covered in quick reference
- Improved navigation between files

### Eliminated Content Duplication
- **Permission errors**: Quick fix vs detailed diagnosis separation
- **Python version issues**: Rapid solution vs comprehensive management
- **Component installation**: Basic fix vs advanced dependency resolution
- **Command problems**: Immediate fixes vs deep troubleshooting

### User Experience Improvements
- Clear file purpose distinction (quick vs detailed help)
- Progressive support pathway (2-min fixes → comprehensive guide)
- Eliminated ~400 lines of redundant content
- Better cross-file navigation and reference system

## Result:
- No duplicate content between troubleshooting files
- Faster problem resolution with clear escalation path
- Improved maintainability and reduced documentation debt
- Enhanced user experience with appropriate help level selection

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-18 12:55:14 +02:00
NomenAK
1eab5e3bc4 🔧 Fix command syntax inconsistencies and improve documentation clarity
## Command Syntax Standardization
- Fix lowercase "superclaude" → "SuperClaude" in installation.md
- Distinguish between terminal commands (SuperClaude install) and Claude Code commands (/sc:*)
- Add clear command context headers to all major documentation files

## Documentation Improvements
- Add command reference tables to key guides
- Create visual distinction markers (🖥️ Terminal vs 💬 Claude Code)
- Update verification sections with proper command separation
- Fix content duplications in Developer-Guide and Getting-Started files

## Cross-Reference Updates
- Standardize all documentation links to use Docs/ prefix structure
- Replace invalid email addresses with anton.knoery@gmail.com
- Remove non-existent team references from security documentation

## Files Enhanced
- Getting-Started: installation.md, quick-start.md with command clarity
- User-Guide: commands.md with comprehensive command context
- Reference: troubleshooting.md, common-issues.md with mixed command support
- Root files: README.md, CONTRIBUTING.md, SECURITY.md link updates

This resolves command confusion between installation (terminal) and development (/sc:) commands.

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-18 12:45:06 +02:00
NomenAK
d2f4ef43e4 📁 Major documentation restructure and comprehensive Reference section
- Restructured all documentation under unified Docs/ directory
- Removed outdated phase summaries and consolidated content
- Added comprehensive Reference section with 11 new guides:
  * Advanced patterns and workflows
  * Basic examples and common issues
  * Integration patterns and MCP server guides
  * Optimization and diagnostic references
- Enhanced User-Guide with updated agent and mode documentation
- Updated MCP configurations for morphllm and serena
- Added TODO.md for project tracking
- Maintained existing content quality while improving organization

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-18 11:58:55 +02:00