Skip to content

Conversation

@nbost130
Copy link

Summary

Significantly enhances the command-system.md documentation with detailed standards, anti-patterns, troubleshooting, and best practices for executable TypeScript .md commands.

Changes Made

Documentation Enhancements

  • Core Principle: Emphasized "ONE FILE = DOCUMENTATION + CODE" pattern
  • TypeScript Standards: Added inline requirements (no any types, explicit returns, proper interfaces, error handling)
  • Anti-Patterns Section: Added 4 common mistakes with explanations:
    • Separate .md and .ts files
    • Missing shebang
    • Regular comments instead of JSDoc
    • Using any types

Improved Organization

  • Enhanced Best Practices: Expanded from 4 to 7 specific practices
  • Comprehensive Troubleshooting: Added detailed sections for:
    • Command not executable
    • Command not in PAI index
    • TypeScript errors
    • Debugging commands
  • Reference Commands: Added section pointing to real examples in codebase

Sanitization

  • All paths use PAI-standard format (${PAI_DIR})
  • Removed personal system references
  • Consistent with PAI infrastructure conventions

Impact

  • Provides clear guidance for contributors creating executable commands
  • Prevents common mistakes through anti-patterns section
  • Improves discoverability with troubleshooting examples
  • Maintains consistency across PAI command ecosystem

Related

🤖 Generated with Claude Code

- Add "ONE FILE" core principle for executable .md commands
- Include TypeScript standards requirements inline
- Add anti-patterns section with 4 common mistakes
- Enhance troubleshooting with specific command examples
- Add reference commands section for learning
- Improve best practices organization
- Use PAI-standard paths throughout (${PAI_DIR})
- Remove personal system references

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

Co-Authored-By: Claude <[email protected]>
@danielmiessler
Copy link
Owner

We just made some major updates. Please review and resubmit if necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants