justin/ClaudeForge
1
0
Fork 0
mirror of https://github.com/alirezarezvani/ClaudeForge.git synced 2026-07-03 18:33:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(v2.0.0): update all documentation files for v2.1.4 architecture

Browse Source 
Updated all README.md and CLAUDE.md files to reflect v2.0.0 changes.

## Documentation Updates

### Root Files
- CLAUDE.md: Added v2.0.0 features section, updated permission syntax examples
- CHANGELOG.md: Added testing scripts to documentation section

### Subfolder READMEs
- agent/README.md: Updated to v2.0.0, added hooks information
- command/README.md: Updated to v2.0.0, added hooks examples
- skill/README.md: Updated to v2.0.0, modernized permission syntax
- skill/examples/README.md: Added v2.0.0 banner and migration notes

## Changes Made

### Version References
- All "1.0.0" → "2.0.0"
- All "Claude Code 2.0+" → "Claude Code 2.1.4+"
- Updated dates to January 2026

### Permission Syntax
- Updated all examples from `tools:` → `permissions:`
- Updated all examples from `allowed-tools:` → `permissions.allow:`
- Added wildcard syntax examples: `Bash(git:*)`

### New Features Documented
- Lifecycle hooks (SessionStart, PreToolUse, PostToolUse)
- Hot-reload capabilities
- Fork-safe mode
- Auto-migration system
- Version detection

### Links Updated
- Added migration guide references throughout
- Fixed internal documentation links
- Removed outdated `generated-*` directory references

All documentation now accurately reflects v2.0.0 architecture and features.

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

Co-Authored-By: Claude Sonnet 4.5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Reza Rezvani
2026-01-13 13:49:45 +01:00
parent 35d17b0ba3
commit 9dd7ec9987
6 changed files with 177 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skill/README.md
+34 -15
View File
@@ -1,9 +1,11 @@
# claude-md-enhancer
# claudeforge-skill
> **Analyze, generate, and enhance CLAUDE.md files for any project type with intelligent templates and best practices.**
A comprehensive Claude Code skill that helps teams create and maintain high-quality CLAUDE.md files. Supports analysis, validation, generation, and enhancement with tech stack customization, team size adaptation, and modular architecture.
**v2.0.0 Update**: Now uses modern `permissions:` syntax for tool access control, replacing deprecated `tools:` and `allowed-tools:` configurations.
## Features
🆕 **Interactive Initialization** - Explore repository, detect project context, and create CLAUDE.md through conversational workflow
@@ -27,7 +29,7 @@ A comprehensive Claude Code skill that helps teams create and maintain high-qual
```bash
# Copy skill folder to your project
cp -r claude-md-enhancer /path/to/your/project/.claude/skills/
cp -r skill /path/to/your/project/.claude/skills/claudeforge-skill/
# Restart Claude Code or reload skills
```
@@ -36,9 +38,10 @@ cp -r claude-md-enhancer /path/to/your/project/.claude/skills/
```bash
# Copy skill folder to user skills directory
cp -r claude-md-enhancer ~/.claude/skills/
cp -r skill ~/.claude/skills/claudeforge-skill/
# Available across all your projects
# Note: v2.0.0 auto-migrates from old claude-md-enhancer name
```
#### Option 3: Claude Apps
@@ -55,7 +58,7 @@ cp -r claude-md-enhancer ~/.claude/skills/
#### New Project (Interactive Initialization)
```
Hey Claude—I just added the "claude-md-enhancer" skill. I don't have a CLAUDE.md file yet. Can you help me create one for this project?
Hey Claude—I just added the "claudeforge-skill". I don't have a CLAUDE.md file yet. Can you help me create one for this project?
```
Claude will:
@@ -67,7 +70,7 @@ Claude will:
#### Existing Project
```
Hey Claude—I just added the "claude-md-enhancer" skill. Can you analyze my CLAUDE.md and suggest improvements?
Hey Claude—I just added the "claudeforge-skill". Can you analyze my CLAUDE.md and suggest improvements?
```
See [HOW_TO_USE.md](HOW_TO_USE.md) for comprehensive examples.
@@ -79,18 +82,21 @@ See [HOW_TO_USE.md](HOW_TO_USE.md) for comprehensive examples.
### Module Overview
```
claude-md-enhancer/
claudeforge-skill/
├── SKILL.md # Skill definition with YAML frontmatter
├── analyzer.py # Analyzes existing CLAUDE.md files
├── validator.py # Validates against best practices
├── generator.py # Generates new content
├── template_selector.py # Selects appropriate templates
├── workflow.py # Interactive initialization workflow
├── sample_input.json # Example inputs
├── expected_output.json # Expected outputs
├── HOW_TO_USE.md # Usage examples
└── README.md # This file
```
**v2.0.0**: Updated SKILL.md now uses `permissions:` instead of `tools:` for better security and control.
### Python Modules
#### `workflow.py` - Initialization Workflow (New!)
@@ -459,9 +465,10 @@ Before finalizing any CLAUDE.md generation:
## Version
**Version**: 1.0.0
**Last Updated**: November 2025
**Compatible**: Claude Code 2.0+, Claude Apps, Claude API
**Version**: 2.0.0
**Last Updated**: January 2026
**Compatible**: Claude Code 2.1.4+, Claude Apps, Claude API
**Migration**: See [../docs/MIGRATION_V2.md](../docs/MIGRATION_V2.md) for upgrade guide from v1.x
---
@@ -505,23 +512,34 @@ For automatic CLAUDE.md maintenance throughout your project lifecycle, use the *
```bash
# User-level (all projects)
cp generated-agents/claude-md-guardian.md ~/.claude/agents/
cp agent/claude-md-guardian.md ~/.claude/agents/
# Project-level (current project)
cp generated-agents/claude-md-guardian.md .claude/agents/
cp agent/claude-md-guardian.md .claude/agents/
```
### How They Work Together
```
claude-md-guardian (agent) → Uses → claude-md-enhancer (skill)
claude-md-guardian (agent) → Uses → claudeforge-skill (skill)
↓
Detects changes → Invokes skill → Updates CLAUDE.md
```
**Result**: Your CLAUDE.md stays synchronized with your codebase automatically!
See `generated-agents/claude-md-guardian-README.md` for complete agent documentation.
**v2.0.0**: Agent now uses `permissions:` syntax for controlled tool access. Example:
```yaml
permissions:
allow:
- Bash(git:*)
- Read
- Write
- Skill(claudeforge-skill)
```
See `agent/README.md` for complete agent documentation.
---
@@ -529,8 +547,9 @@ See `generated-agents/claude-md-guardian-README.md` for complete agent documenta
- **Documentation**: See [SKILL.md](SKILL.md) for complete documentation
- **Examples**: See [HOW_TO_USE.md](HOW_TO_USE.md) for usage examples
- **Companion Agent**: See `../../generated-agents/claude-md-guardian-README.md`
- **Slash Command**: See `../../generated-commands/enhance-claude-md/README.md`
- **Companion Agent**: See [../agent/README.md](../agent/README.md)
- **Slash Command**: See [../command/README.md](../command/README.md)
- **Migration Guide**: See [../docs/MIGRATION_V2.md](../docs/MIGRATION_V2.md)
- **Issues**: Report bugs in the main repository
- **Community**: Share your CLAUDE.md setups and best practices
skill/examples/README.md
+25 -4
View File
@@ -2,7 +2,9 @@
This folder contains reference implementations of CLAUDE.md files for different project types and team sizes.
**✨ NEW**: All examples now follow **100% native Claude Code format** with proper project structure diagrams, setup instructions, architecture sections, and file structure explanations - matching the official `/update-claude-md` slash command format.
**✨ v2.0.0 Update**: All examples now follow **100% native Claude Code format** with proper project structure diagrams, setup instructions, architecture sections, and file structure explanations - matching the official `/update-claude-md` slash command format.
**New in v2.0.0**: Examples demonstrate modern `permissions:` syntax for skills and agents, replacing deprecated `tools:` configurations.
## Available Examples
@@ -59,16 +61,18 @@ cp examples/modular-backend-CLAUDE.md /path/to/your/project/backend/CLAUDE.md
cp examples/modular-frontend-CLAUDE.md /path/to/your/project/frontend/CLAUDE.md
```
### 3. Using with claude-md-enhancer Skill
### 3. Using with claudeforge-skill
These examples demonstrate the output quality you can expect from the skill:
```
Hey Claude—I just added the "claude-md-enhancer" skill.
Hey Claude—I just added the "claudeforge-skill".
Can you create a CLAUDE.md similar to the core-small-team example
but customized for my Go API project?
```
**v2.0.0**: The skill now uses `permissions:` syntax for secure tool access control.
## Template Selection Guide
### Choose Minimal Template When:
@@ -114,6 +118,8 @@ All examples now include these **native Claude Code sections**:
**Why This Matters**: These sections match the official `/update-claude-md` slash command format, ensuring Claude Code can navigate and understand your codebase efficiently.
**v2.0.0 Compatibility**: All examples are compatible with Claude Code 2.1.4+ and use modern permission syntax where applicable.
### Expected Quality Scores
| Example | Quality Score |
@@ -132,7 +138,22 @@ All examples now include these **native Claude Code sections**:
3. **Add Team Standards**: Include team-specific conventions
4. **Update Commands**: Replace commands with your actual npm/yarn/poetry scripts
5. **Add Context**: Include project-specific context that helps Claude understand your goals
6. **v2.0.0**: Use `permissions:` syntax in skills/agents instead of deprecated `tools:` or `allowed-tools:`
## Contributing
These examples represent best practices as of November 2025. If you have improvements or additional examples, please contribute them!
These examples represent best practices as of January 2026. If you have improvements or additional examples, please contribute them!
## Version
- **Version**: 2.0.0
- **Last Updated**: January 2026
- **Compatible**: Claude Code 2.1.4+
- **Migration Guide**: See [../../docs/MIGRATION_V2.md](../../docs/MIGRATION_V2.md) for upgrade instructions
## Related Documentation
- **Skill Documentation**: [../README.md](../README.md)
- **Agent Documentation**: [../../agent/README.md](../../agent/README.md)
- **Command Documentation**: [../../command/README.md](../../command/README.md)
- **Migration Guide**: [../../docs/MIGRATION_V2.md](../../docs/MIGRATION_V2.md)