docs: add JSDoc documentation for ClineAsk and ClineSay types

[hannesrudolph]

Related GitHub Issue

Closes: #1848

Description

This PR adds comprehensive JSDoc documentation to the clineAsks and clineSays type arrays in packages/types/src/message.ts. The documentation provides clear descriptions for each message type variant, helping developers understand:

• The purpose of each message type
• When each type is used in the application flow
• How the types relate to user interactions and system communications

Key implementation details:

• Added detailed JSDoc blocks above both type arrays
• Documented all 12 ClineAsk variants with their specific use cases
• Documented all 24 ClineSay variants with their specific purposes
• No structural changes were made to the types themselves - this is purely a documentation enhancement

Test Procedure

1. Automated Testing:

   • Ran pnpm test in the types package workspace - all tests pass
   • Ran full test suite from root - 2075 tests passing (1 unrelated failure in PowerShell terminal test)

2. Manual Verification:

   • Verified JSDoc appears correctly in IDE tooltips when hovering over the types
   • Searched codebase to confirm all descriptions accurately reflect actual usage
   • Confirmed no breaking changes by checking that all imports and usages remain unchanged

3. Documentation Accuracy:

   • Cross-referenced each type description with its actual usage in the codebase
   • Verified all 36 type descriptions are accurate and meaningful

Type of Change

• 🐛 Bug Fix: Non-breaking change that fixes an issue.
• ✨ New Feature: Non-breaking change that adds functionality.
• 💥 Breaking Change: Fix or feature that would cause existing functionality to not work as expected.
• ♻️ Refactor: Code change that neither fixes a bug nor adds a feature.
• 💅 Style: Changes that do not affect the meaning of the code (white-space, formatting, etc.).
• 📚 Documentation: Updates to documentation files.
• ⚙️ Build/CI: Changes to the build process or CI configuration.
• 🧹 Chore: Other changes that don't modify src or test files.

Pre-Submission Checklist

• Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
• Scope: My changes are focused on the linked issue (one major feature/fix per PR).
• Self-Review: I have performed a thorough self-review of my code.
• Code Quality:
  • My code adheres to the project's style guidelines.
  • There are no new linting errors or warnings (npm run lint).
  • All debug code (e.g., console.log) has been removed.
• Testing:
  • New and/or updated tests have been added to cover my changes.
  • All tests pass locally (npm test).
  • The application builds successfully with my changes.
• Branch Hygiene: My branch is up-to-date (rebased) with the main branch.
• Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
• Changeset: A changeset has been created using npm run changeset if this PR includes user-facing changes or dependency updates.
• Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Screenshots / Videos

N/A - This is a documentation-only change with no UI impact.

Documentation Updates

• No documentation updates are required.

This PR itself IS the documentation update. The JSDoc comments added will be automatically picked up by IDEs and documentation generators.

Additional Notes

The descriptions were verified against actual usage throughout the codebase to ensure accuracy. All message types are now properly documented, which will significantly improve the developer experience when working with these critical types.

---

Important

Add JSDoc documentation for clineAsks and clineSays in message.ts, detailing 36 type variants.

• Documentation:
  • Added JSDoc to clineAsks and clineSays in message.ts.
  • Documented 12 ClineAsk variants and 24 ClineSay variants with descriptions and use cases.
  • No changes to type structures, purely documentation enhancement.

^{This description was created by for ebde26a. You can customize this summary. It will automatically update as commits are pushed.}

[daniel-lxs]

LGTM

The failing test is unrelated.

[mrubens]

This seems helpful - any ideas on how to keep them up to date as we add stuff? Happy to merge for now but we might want to add a rule or a comment somewhere.