1
0
mirror of https://github.com/steipete/agent-rules.git synced 2025-12-16 12:00:09 +01:00

38 Commits

Author SHA1 Message Date
Peter Steinberger
315e98c7a9 Normalize header format 2025-11-25 14:06:46 +01:00
Peter Steinberger
8f9a6f0f13 Add scroll emoji to title 2025-11-25 13:08:39 +01:00
Peter Steinberger
051d8b6925 Add Swift 6 concurrency migration guide
Comprehensive guide covering:
- Data race safety and isolation domains
- Common compiler errors and solutions
- Migration strategy and incremental adoption
- Build configuration for Swift 6 language mode
- Runtime behavior and source compatibility
2025-08-08 17:52:40 +02:00
Peter Steinberger
8fcff0fa27 Update Swift 6 Concurrency doc 2025-06-25 12:15:55 +02:00
Peter Steinberger
0570b79392 update docs 2025-06-25 12:11:27 +02:00
Peter Steinberger
235305b804 add swift data 2025-06-15 18:00:51 +02:00
Peter Steinberger
71a8eee0dc add modern swift 2025-06-15 09:26:21 +02:00
Peter Steinberger
64caee2547 add swiftui docs 2025-06-14 11:25:57 +02:00
Peter Steinberger
0fc7e67005 docs: make Terminal Title Trick section self-contained
- Add context explaining the problem it solves
- Add 'What it does' section with bullet points
- Add 'Usage' section explaining how to use cly
- Include example of what the terminal title looks like
- Make the section understandable without external references
2025-06-13 05:03:34 +02:00
Peter Steinberger
49a45a3e56 docs: instruct AI to read README for slash command details
- Add instruction #5 for AI assistants to read main README
- Include URLs to both README and project-rules directory
- Add /modern-swift to the command list
- Change to 20+ commands to reflect growing collection
- Make it clear that detailed descriptions are in the README
2025-06-13 04:59:45 +02:00
Peter Steinberger
3f6b1c00af docs: fix cly function description and improve blog link context
- Remove incorrect mention of npm update functionality
- Clarify that cly bypasses permission prompts
- Link specifically mentions 'terminal title trick' for better context
- Keep the simple, working version of the cly function
2025-06-13 04:59:05 +02:00
Peter Steinberger
e2c02ac1ce docs: replace top blog link with Terminal Title Trick section
- Remove blog link from top of document
- Add Terminal Title Trick section with cly function
- Include code example for ~/.zshrc
- Move blog post reference to end of tips section
- Explain benefit of seeing folder names in terminal tabs
2025-06-13 04:56:27 +02:00
Peter Steinberger
59fe6e5d84 docs: restore tips section and add blog post reference
- Re-add Tips section with important reminders
- Add link to blog post explaining MCP servers and slash commands
- Include tips about -s user flag, API key handling, and path validation
2025-06-13 04:52:48 +02:00
Peter Steinberger
ed8b5a08af fix: restore balanced MCP documentation with proper installation instructions
- Increase from 89 to 213 lines for better clarity
- Add specific installation instructions for each IDE:
  - Claude Code (CLI commands)
  - Claude Desktop (JSON config)
  - Cursor, Windsurf, VS Code (config examples)
- Include actual JSON configurations for copy-paste
- Keep concise overview and clear rules
- Trust AI intelligence while providing necessary details
- Add presentation template for consistency

This strikes a balance between being too minimal and too verbose.
2025-06-13 04:47:20 +02:00
Peter Steinberger
260c88c2ea refactor: simplify MCP documentation to trust AI intelligence
- Reduce from 1085 lines to 89 lines (92% reduction)
- Remove all scripts and verbose installation instructions
- Reference GitHub repos for detailed descriptions
- Keep only essential quick install commands
- Trust that AI assistants are intelligent enough to figure things out
- Focus on clear rules and a simple presentation template

The new document:
- States clear rules for AI assistants
- Provides a presentation template
- Lists quick install commands
- References external docs for details
- Assumes both user and AI are intelligent
2025-06-13 04:43:00 +02:00
Peter Steinberger
818f6b8851 refactor: simplify MCP documentation by extracting scripts
- Extract all large bash scripts to separate files in scripts/ directory
- Replace embedded scripts with simple curl commands
- Create streamlined installation guide for AI assistants
- Add complete-claude-setup.sh as the primary recommended install
- Reduce document size from ~1700 to ~1100 lines
- Make documentation more maintainable and easier to update

Scripts created:
- check-api-keys.sh - Check for available API keys
- install-claude-mcps.sh - Install MCP servers to Claude Code
- quick-install-mcps.sh - Quick install with available prerequisites
- Plus placeholder references for other IDE installers

This makes the documentation much cleaner and directs AI assistants to use simple one-line commands instead of copying large scripts.
2025-06-13 04:35:02 +02:00
Peter Steinberger
179736b1fa fix: improve MCP setup guide to prevent JSON errors and ensure project rules are presented
- Add working JSON examples to prevent syntax errors shown in screenshot
- Add 'Common Installation Errors' section with solutions
- Create 'Quick Install Commands' section with copy-paste ready commands
- Restructure presentation format to ALWAYS show both MCP servers AND slash commands
- Update rule #3 to require presenting both parts together
- Create complete-claude-setup.sh that installs both MCP servers and project rules
- Add clear two-part presentation format (PART 1: MCP, PART 2: Slash Commands)
- Add one-line complete setup command for easy installation

This addresses the issues where:
1. AI was making JSON syntax errors with claude mcp add-json
2. AI completely forgot to mention the 20 slash commands
3. Installation was presented in a confusing way
2025-06-13 04:24:22 +02:00
Peter Steinberger
db7c4264e4 feat: make project rules (slash commands) more prominent in MCP setup
- Add rule #3 to ALWAYS mention project rules when setting up Claude Code
- Update presentation format to prominently feature 20 slash commands
- Add reminder in quick installation script about project rules
- Clarify that slash commands are development tools for Claude Code
- Update setup helper to mention Claude Code specifically

This ensures AI assistants will always inform users about the available slash commands like /commit, /bug-fix, /pr-review, etc. when helping with Claude Code setup.
2025-06-13 04:14:51 +02:00
Peter Steinberger
953d1a40ef fix: strengthen instructions to prevent AI from recommending app installations
- Add explicit warnings about Claude Code vs Claude Desktop
- Add rule #6 and #7 to NEVER suggest downloads or assume Claude Desktop
- Add example of wrong vs correct approach for clarity
- Update setup-mcps.sh to clarify it's for Claude Code
- Add conditional checks in verification script for apps
- Update presentation format to explicitly mention Claude Code

This addresses the issue where AI assistants incorrectly recommend installing Claude Desktop when users are already using Claude Code.
2025-06-13 04:10:21 +02:00
Peter Steinberger
fabfc33863 🐛 fix: Remove all software installation suggestions from documentation
- Replace all 'brew install' commands with messages to contact administrator
- Remove Node.js installation instructions
- Make Ollama optional, not auto-installed
- Fix Obsidian plugin references to not suggest installation
- Remove download suggestions for missing software
- Ensure scripts fail gracefully when prerequisites missing
- Align with strict 'no installations' policy
2025-06-13 04:03:47 +02:00
Peter Steinberger
b64e549c2e 📝 docs: Add critical instructions to prevent unwanted app installation recommendations
- Add prominent warning section at top of document
- Clarify NEVER to recommend installing ANY applications
- Emphasize working only with existing installed tools
- Specific instructions to not suggest Claude Desktop, IDEs, or Obsidian
- Clear guidance on conditional recommendations based on prerequisites
- Prevent AI from suggesting software downloads or installations
2025-06-13 03:58:51 +02:00
Peter Steinberger
9653231ed5 feat: Add project rules (slash commands) installation and customization
- Install 20 project rules as slash commands for Claude Code (/commit, /bug-fix, etc)
- Create install-project-rules.sh to set up commands via CLAUDE.md import
- Add comprehensive documentation with clear one-line descriptions for each command
- Create tweak-claude.sh for easy post-installation customization
- Update setup-mcps.sh to offer project rules installation
- Add Customization & Tweaks section to documentation
- Organize commands by category: Git, Code Quality, Documentation, etc
2025-06-13 03:51:35 +02:00
Peter Steinberger
2ba49a0082 Enhanced MCP documentation with conditional installation and API key handling
- Added pre-installation API key checks with conditional server installation
- Fixed Firecrawl to correctly require API key (not optional)
- Added GitHub MCP authentication setup with detailed instructions
- Added Obsidian.app existence check before recommending Obsidian MCP
- Emphasized Peekaboo as essential screenshot tool that works without AI
- Added instructions for Claude to present MCPs with clear one-liners
- Added two methods for providing API keys: .zshrc or direct paste
- Added quick start section for fetching files from GitHub
- Created setup-mcps.sh helper script for easy installation
- Updated to correct date: June 13, 2025
2025-06-13 03:03:40 +02:00
Peter Steinberger
ad332204f1 Update script 2025-06-13 02:49:18 +02:00
Peter Steinberger
495810f053 Add MCP configuration documentation and sync improvements
- Update mcp-sync-rule.md with enhanced synchronization instructions
- Improve mcp-sync.sh script functionality
- Add steipete-mcps.md documenting personal MCP server setup
2025-06-13 02:44:55 +02:00
Peter Steinberger
9ea8003764 Move 'Why This Format?' section to bottom of README
Reorganized README for better flow - format explanation is now
at the end after users understand the content and usage.

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 14:28:22 +02:00
Peter Steinberger
6c9a43512a Add global Claude Code rules and reorganize structure
Major changes:
- Moved github-issue-creation.mdc to global-rules/ (better suited as global rule)
- Added terminal-title-wrapper.zsh for dynamic terminal titles
- Added mcp-peekaboo-setup.mdc for vision-enabled MCP server
- Updated README with comprehensive documentation for all rules

Global rules enhance Claude Code across all projects:
- GitHub issue creation from feature descriptions
- Terminal title management for multi-instance organization
- Peekaboo MCP setup for screenshot/vision capabilities

Based on strategies from "Commanding Your Claude Code Army"

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 14:24:59 +02:00
Peter Steinberger
b14f443855 Add 15 new development workflow rules from claude-code
Added comprehensive rules adapted from vincenthopf/claude-code:

Development Workflows:
- commit.mdc, commit-fast.mdc: Git commit workflows
- add-to-changelog.mdc: Structured changelog updates
- pr-review.mdc: Multi-role PR review checklist

Code Quality:
- check.mdc: Multi-language code quality checks
- clean.mdc: Auto-fix formatting and linting
- code-analysis.mdc: Advanced analysis options

Problem Solving:
- analyze-issue.mdc: GitHub issue analysis
- bug-fix.mdc: Complete bug-fixing workflow
- implement-task.mdc: Methodical implementation
- five.mdc: Five Whys root cause analysis

Documentation:
- create-docs.mdc: Comprehensive doc generation
- mermaid.mdc: Diagram generation

Project Setup:
- context-prime.mdc: Load project context
- create-command.mdc: Create custom commands

Credit: @vincenthopf (https://github.com/vincenthopf/claude-code)

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 14:19:32 +02:00
Peter Steinberger
e3d9dbf805 Organize repository into project-rules and docs folders
- Created docs/ folder for reference documentation (Swift, MCP guides)
- Created project-rules/ folder for actionable AI assistant rules
- Separated content by purpose:
  - docs/: Knowledge bases and API documentation
  - project-rules/: Rules for AI behavior and automation
- Updated README with clearer structure and usage instructions

This organization makes it easier to distinguish between reference
materials and actionable rules for AI assistants.

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 14:04:47 +02:00
Peter Steinberger
e672de90d5 Restructure repository with unified .mdc format
Major changes:
- Moved all rules to root directory (removed cursor-rules/ and llms/ subdirs)
- Renamed all rule files from .md to .mdc extension
- Added proper YAML frontmatter to all files with description, globs, and alwaysApply
- Updated README with explanation of unified format that works with both Claude Code and Cursor
- Removed empty directories

The .mdc format provides compatibility:
- Cursor uses the YAML frontmatter for rule configuration
- Claude Code reads the markdown content, ignoring frontmatter
- Same files work in both tools without modification

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 14:00:20 +02:00
Peter Steinberger
8734d733eb Add MCP best practices documentation
- Added mcp-best-practices.md to llms/ directory
- Comprehensive guide for building Model Context Protocol servers
- Updated README documentation

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:40:46 +02:00
Peter Steinberger
9eb7f62ff0 Add MCP releasing guide and generalize documentation
- Added mcp-releasing.md: Generic guide for releasing MCP servers as NPM packages
- Made mcp-inspector-debugging.md generic with placeholders instead of specific project references
- Removed hardcoded credentials and project-specific paths
- Updated README to reflect new documentation

All docs now use placeholders like [MCP_SERVER_NAME], [WORKSPACE_PATH], etc.
for better reusability across different projects.

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:38:58 +02:00
Peter Steinberger
22f326297c Add Swift 6 migration guide
- Added swift6-migration.md to llms/ directory
- Comprehensive guide for Swift 6 concurrency and language changes
- Updated README documentation

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:35:11 +02:00
Peter Steinberger
bb71fd7f1e Add Swift Argument Parser documentation and remove MCP guidelines
- Added swift-argument-parser.md to llms/ directory
- Removed mcp-development-guidelines.md from cursor-rules/
- Updated README with Swift Argument Parser documentation

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:33:54 +02:00
Peter Steinberger
770c19e5bd Add Cursor rules collection from various projects
- Added cursor-rules/ directory with 4 valuable rule sets
- MCP development guidelines with security patterns
- Cursor rules meta-guide for creating rules
- Safari automation patterns and techniques
- MCP Inspector debugging workflows

These rules demonstrate proven patterns for development, automation,
testing, and debugging across different project types.

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:29:52 +02:00
Peter Steinberger
ca8b141b49 Add LLM documentation for Swift development
- Added llms/ directory with Swift framework documentation
- Includes Swift @Observable, Observation, and Testing framework docs
- Reference materials for AI assistants working with Swift code

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:23:46 +02:00
Peter Steinberger
aafdf7ecdc Add GitHub issue creation rule by @nityeshaga
- Added comprehensive rule for creating well-structured GitHub issues
- Includes 5-step process: research, best practices, planning, creation, output
- Credit: https://x.com/nityeshaga/status/1933113428379574367

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

Co-Authored-By: Claude <noreply@anthropic.com>
2025-06-12 13:13:44 +02:00
Peter Steinberger
01167007f9 Initial commit 2025-06-12 13:10:15 +02:00