mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
docs: Fix documentation inconsistencies and version references
- Fix version numbers: Changed 4.0.x to 2.0.x in SECURITY.md - Fix CHANGELOG.md: Changed SuperClaude v4.0.0 to v1.0.0 - Add missing /task command to README.md command list - Remove non-existent validate-references.sh from CONTRIBUTING.md - Clarify installation paths (files go to ~/.claude/ not project dir) - Add MCP server installation notice to README.md - Ensure consistent v2.0.1 references across all docs 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
57
CHANGELOG.md
Normal file
57
CHANGELOG.md
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to SuperClaude will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [2.0.1] - 2025-06-26
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `--introspect` flag for framework self-analysis and improvement capabilities
|
||||||
|
- Enhanced SuperClaude identity declaration with mission statement
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Corrected file count reporting in install.sh verification process
|
||||||
|
- Resolved critical file copying issues in install.sh
|
||||||
|
|
||||||
|
## [2.0.0] - 2025-06-26
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Comprehensive security and robustness improvements to install.sh
|
||||||
|
- Optimize all 18 command files using @include reference system
|
||||||
|
- Commands cheat sheet documentation
|
||||||
|
- Custom installation directory support (#4)
|
||||||
|
- Community interaction files (CONTRIBUTING.md, CODE_OF_CONDUCT.md)
|
||||||
|
- MIT License
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Complete migration to v2 with @include reference system
|
||||||
|
- Standardized @include reference system across all command files
|
||||||
|
- Migrated PERSONAS to flag system for Claude Code compliance
|
||||||
|
- Transformed README.md into engaging developer-friendly format
|
||||||
|
- Major optimization achieving 35% token reduction through template system & file consolidation
|
||||||
|
- Enhanced Task Management System - Adaptation of PR #5 (#7)
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- All hard claims, metrics, and numeric targets
|
||||||
|
- All references to user: and project: prefixes
|
||||||
|
- References to deleted scripts and pattern system
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Shared resources count in install.sh
|
||||||
|
- .gitignore configuration and removed logs/claudedocs from tracking
|
||||||
|
|
||||||
|
## [1.0.0] - 2025-06-22
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Initial release of SuperClaude v1.0.0 configuration framework
|
||||||
|
- Core configuration system with CLAUDE.md
|
||||||
|
- Command system with 18 optimized command files
|
||||||
|
- Shared resources and patterns
|
||||||
|
- Installation script (install.sh)
|
||||||
|
- Comprehensive documentation
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*Note: This changelog was generated from git history. For detailed commit messages, run `git log`.*
|
||||||
@@ -49,6 +49,8 @@ Thanks for contributing to SuperClaude! This guide helps you get started.
|
|||||||
## Development Guidelines
|
## Development Guidelines
|
||||||
|
|
||||||
### File Structure
|
### File Structure
|
||||||
|
|
||||||
|
**Repository Structure:**
|
||||||
```
|
```
|
||||||
SuperClaude/
|
SuperClaude/
|
||||||
├── CLAUDE.md, RULES.md, PERSONAS.md, MCP.md # Core configs
|
├── CLAUDE.md, RULES.md, PERSONAS.md, MCP.md # Core configs
|
||||||
@@ -58,6 +60,14 @@ SuperClaude/
|
|||||||
└── README.md # Documentation
|
└── README.md # Documentation
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**After Installation (in ~/.claude/):**
|
||||||
|
```
|
||||||
|
~/.claude/
|
||||||
|
├── CLAUDE.md, RULES.md, PERSONAS.md, MCP.md # Installed configs
|
||||||
|
├── commands/ # Installed commands
|
||||||
|
└── commands/shared/ # Installed resources
|
||||||
|
```
|
||||||
|
|
||||||
### Code Standards
|
### Code Standards
|
||||||
- **YAML**: 2-space indentation, descriptive keys
|
- **YAML**: 2-space indentation, descriptive keys
|
||||||
- **Markdown**: Clear headers, consistent formatting
|
- **Markdown**: Clear headers, consistent formatting
|
||||||
@@ -69,7 +79,6 @@ SuperClaude/
|
|||||||
- Verify slash commands work in Claude Code
|
- Verify slash commands work in Claude Code
|
||||||
- Check YAML syntax validity
|
- Check YAML syntax validity
|
||||||
- Test personas & MCP integration
|
- Test personas & MCP integration
|
||||||
- Run `validate-references.sh` to check @pattern system
|
|
||||||
|
|
||||||
## Submission Process
|
## Submission Process
|
||||||
|
|
||||||
@@ -141,7 +150,7 @@ Description & purpose
|
|||||||
2. **Purpose**: Reusable configurations & @pattern templates
|
2. **Purpose**: Reusable configurations & @pattern templates
|
||||||
3. **Naming**: descriptive-name.yml
|
3. **Naming**: descriptive-name.yml
|
||||||
4. **Structure**: Clear, documented sections
|
4. **Structure**: Clear, documented sections
|
||||||
5. **Validation**: Use `validate-references.sh` to check @pattern links
|
5. **Validation**: Check @pattern links manually for correctness
|
||||||
|
|
||||||
## Persona Development
|
## Persona Development
|
||||||
|
|
||||||
|
|||||||
@@ -71,6 +71,8 @@ cd SuperClaude
|
|||||||
|
|
||||||
Zero dependencies. Installs to `~/.claude/` by default.
|
Zero dependencies. Installs to `~/.claude/` by default.
|
||||||
|
|
||||||
|
**Note:** After installation, all configuration files are located in `~/.claude/` (your home directory), not in the project directory.
|
||||||
|
|
||||||
## 💡 Core Capabilities
|
## 💡 Core Capabilities
|
||||||
|
|
||||||
### 🧠 **Cognitive Personas (Now as Flags!)**
|
### 🧠 **Cognitive Personas (Now as Flags!)**
|
||||||
@@ -117,6 +119,8 @@ Development lifecycle coverage:
|
|||||||
- **Magic**: AI-generated UI components
|
- **Magic**: AI-generated UI components
|
||||||
- **Puppeteer**: Browser testing and automation
|
- **Puppeteer**: Browser testing and automation
|
||||||
|
|
||||||
|
**⚠️ Important:** SuperClaude does not include MCP servers. You need to install them separately in Claude Code's MCP settings to use MCP-related flags (--c7, --seq, --magic, --pup).
|
||||||
|
|
||||||
### 📊 **Token Efficiency**
|
### 📊 **Token Efficiency**
|
||||||
SuperClaude's @include template system helps manage token usage:
|
SuperClaude's @include template system helps manage token usage:
|
||||||
- **UltraCompressed mode** option for token reduction
|
- **UltraCompressed mode** option for token reduction
|
||||||
|
|||||||
@@ -4,8 +4,8 @@
|
|||||||
|
|
||||||
| Version | Supported |
|
| Version | Supported |
|
||||||
|---------|-----------|
|
|---------|-----------|
|
||||||
| 4.0.x | ✅ Yes |
|
| 2.0.x | ✅ Yes |
|
||||||
| < 4.0 | ❌ No |
|
| < 2.0 | ❌ No |
|
||||||
|
|
||||||
## Reporting Security Vulnerabilities
|
## Reporting Security Vulnerabilities
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user