Skip to content

docs: enhance CLAUDE.md with comprehensive developer guidance#70

Merged
renatobardi merged 6 commits intomainfrom
docs/migrate-dashboard-url
Apr 17, 2026
Merged

docs: enhance CLAUDE.md with comprehensive developer guidance#70
renatobardi merged 6 commits intomainfrom
docs/migrate-dashboard-url

Conversation

@renatobardi
Copy link
Copy Markdown
Owner

Summary

Enhanced CLAUDE.md with 400+ lines of comprehensive developer documentation covering the full hapai development lifecycle:

Sections Added/Improved:

  1. Development Environment Setup — Step-by-step guide for contributors to clone, install, verify, and test
  2. Release Workflow — Complete documentation of tag-release.sh, GitHub Actions release process, and Homebrew integration
  3. Exporters — Table of all exporters (Cursor, Copilot, Windsurf, etc.) with usage instructions
  4. Cloud Functions — Enhanced schema documentation with field details and deployment commands
  5. PR Review Agents — Documentation of _pr-review-agent.sh and _pr-fix-agent.sh with configuration
  6. Testing — Expanded examples for flow-dispatcher, cooldown escalation, audit logging, and multi-platform testing
  7. Troubleshooting — New guide for debugging hook failures, permission issues, and flow chains
  8. Dashboard Configuration — Vite setup details, i18n system, and build instructions
  9. Resources Table — Overview of all documentation files and their purposes (English/Portuguese)
  10. Version Compatibility — Platform support matrix and minimum version requirements

Benefits:

  • Faster onboarding for new contributors
  • Centralized reference for developers working on hooks, dashboard, cloud functions
  • Complete release and Homebrew workflow documentation
  • Practical debugging and troubleshooting guidance

Testing:

  • Existing CLAUDE.md content remains unchanged (backward compatible)
  • All new sections follow existing markdown style and structure
  • No functional changes, documentation-only

renatobardi and others added 6 commits April 16, 2026 23:01
…mprovements

- Added Development Environment Setup section with step-by-step guide
- Added Release Workflow section documenting tag-release.sh and Homebrew integration
- Expanded Exporters documentation with table of all tools and usage instructions
- Enhanced Cloud Functions documentation with schema field details and deployment commands
- Added PR Review Agents section documenting _pr-review-agent.sh and _pr-fix-agent.sh
- Expanded Testing section with flow-dispatcher, cooldown, and audit logging examples
- Added troubleshooting guide for common hook failures and debugging scenarios
- Added Dashboard Vite configuration details and i18n system documentation
- Added Resources table showing documentation structure and language notes
- Added Version Compatibility section with platform support and model versions

These improvements provide comprehensive guidance for developers contributing to hapai,
covering setup, release processes, testing, debugging, and architecture details.
@sonarqubecloud
Copy link
Copy Markdown

@renatobardi renatobardi merged commit 73848ac into main Apr 17, 2026
3 checks passed
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