doc: Improve readme and docs organization

[alexbit-codemod]

Improve README and reorganize documentation

Overview

This PR streamlines the repository's documentation structure and improves the user experience by reorganizing setup guides and simplifying the main README content.

Changes Made

📁 Better Organization

• Moved setup documentation: Relocated AUTO_PUBLISH_SETUP.md to .github/ directory for better organization with other GitHub-specific files

�� Streamlined README

• Focused content: Removed verbose setup instructions from main README to focus on user-facing content
• Clear navigation: Added prominent callout for framework maintainers with direct link to setup guide
• Improved structure: Simplified overview and removed redundant sections

🚨 Enhanced User Safety

• Added caution warning: Prominent warning about codemods editing code with Git safety recommendations
• Better examples: Replaced placeholder commands with concrete, working examples (e.g., @nodejs/tmpDir-to-tmpdir)

🧹 Cleanup

• Removed placeholders: Eliminated template placeholders and outdated instructions
• Streamlined sections: Consolidated "Running codemods" section with clearer, more actionable content

Benefits

• Better UX: Users can quickly find what they need without wading through setup details
• Maintainer-friendly: Setup instructions are properly organized and easily discoverable
• Professional appearance: Cleaner, more focused presentation
• Safety first: Clear warnings help prevent accidental code modifications

Files Changed

• README.md - Streamlined content and improved structure
• AUTO_PUBLISH_SETUP.md → .github/AUTO_PUBLISH_SETUP.md - Better organization

Testing

• All links work correctly
• Documentation is clear and actionable
• No broken references or placeholders remain

[github-actions]

📦 Codemod Repository

This repository supports automatic codemod publishing to the Codemod Registry.

To enable auto-publishing:

1. Get API key from https://app.codemod.com/api-keys
2. Create GitHub Environment: Repository Settings → Environments → New environment (name it production)
3. Add secret: CODEMOD_API_KEY with your API key

What happens when enabled:

• ✅ Codemods in recipes/ are automatically published to the registry
• ✅ Version conflicts are auto-resolved (patch version bump)
• ✅ Publishing errors are handled gracefully

---

This comment was automatically generated by the auto-publish detection workflow.