Enhance prompting documentation with comprehensive guidance

[codegen-sh]

Overview

This PR significantly enhances the prompting documentation to provide more comprehensive, practical guidance for users working with Codegen across different platforms and use cases.

Key Improvements

🎯 Platform-Specific Guidance

• Slack Integration: Tips for threading, repo tagging, and status updates
• Linear Integration: Issue management, sub-task breakdown, and acceptance criteria
• GitHub Integration: PR reviews, file references, and review criteria

📋 Common Task Types

Added detailed examples for:

• Code reviews with security and performance focus
• Bug fixing with investigation and monitoring
• Feature development with real-time systems
• Refactoring with testability improvements

🚀 Advanced Techniques

• Context Provision: How to effectively share codebase information
• Iterative Prompting: Building on previous work and follow-ups
• Complex Dependencies: Coordinating changes across multiple services

🔧 Troubleshooting Section

Common issues and solutions:

• "I don't have enough context" → Provide file paths and patterns upfront
• "Changes broke functionality" → Specify regression testing requirements
• "Doesn't match patterns" → Reference specific examples
• "Task too large" → Break down into smaller, specific tasks

💡 Enhanced Best Practices

• Visual card layout for key principles
• Emphasis on Codegen's codebase understanding capabilities
• Links to related documentation sections

What's Preserved

• Maintained the excellent existing structure and core 5-element framework
• Kept all original examples that work well
• Preserved the accessible, scannable format

Files Modified

• docs/introduction/prompting.mdx - Comprehensive enhancement with new sections

The documentation now provides practical, actionable guidance that helps users get better results from Codegen across all supported platforms and use cases.

---

💻 View my work • About Codegen

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[codegen-sh]

I see a check failed - I'm on it! 🫡

💻 View my work

[codegen-sh]

✅ Fixed the failing check suite for PR #1105!

The issue was with formatting in the prompting.mdx file. I've addressed:

• Numbered list formatting (changed to use "1." for all items)
• Removed trailing whitespace
• Added proper spacing before headers
• Ensured file ends with newline

The fix has been pushed to the PR branch in this commit. The formatting issues were being caught by the pre-commit linting tools.

💻 View my work • React 👍 or 👎