docs: Unlock the full potential - Add Use Cases and Contributing Guid…#352
docs: Unlock the full potential - Add Use Cases and Contributing Guid…#352talesperito wants to merge 2 commits into
Conversation
…elines This PR adds two powerful sections that will help users understand and leverage the incredible value of this repository: ## 💡 Use Cases Showcases real-world applications across 5 key user groups: - 🎯 Developers: Code review, documentation, bug fixing, refactoring - 📝 Content Creators: Writing, SEO, multi-language support - 🎨 Designers & No-Code Builders: Rapid prototyping, UI/UX, components - 🔬 Researchers & Analysts: Data analysis, literature review, reports - 🏢 Teams & Organizations: Knowledge base, onboarding, standardization ## 🤝 Contributing Provides clear guidelines to grow this amazing community: - Step-by-step contribution process - Quality standards and best practices - PR template for consistency - Community engagement encouragement **Why this matters**: This repository is a goldmine for AI productivity. These additions will help more people discover its potential and contribute to making it even better. Together, we're building the most comprehensive AI prompts resource in the world! 🚀🌟
WalkthroughREADME.md expanded with new "Use Cases" (roles with example prompts) and a "Contributing" section (guidelines, PR template, community). Changes are documentation-only and duplicated within the file. No code or behavior changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 136-139: Update the redundant label "- **SEO Optimization**: Apply
AI to improve content discoverability" under the "### 📝 For Content Creators"
section by replacing "**SEO Optimization**" with either "**SEO**" or the full
phrase "**Search Engine Optimization**" (choose one consistent form) so the list
item reads e.g. "- **SEO**: Apply AI to improve content discoverability"; keep
the rest of the bullet unchanged.
- Line 209: Change the final sentence "**Thank you for helping build the most
comprehensive AI prompts repository! Your contributions make a real difference
in how people work with AI. 🚀**" into a proper Markdown heading (e.g., prefix
with one or more '#' characters) so it becomes a heading rather than a bare
paragraph; update the README.md by replacing that closing sentence with an
appropriate heading level like "# Thank you for helping build the most
comprehensive AI prompts repository!" (you can keep the second sentence as a
subheading or sentence under it) to satisfy MD036.
- Around line 168-173: Add a language identifier to the fenced code block in the
README excerpt so it becomes ```text instead of ```; locate the block containing
"Tool Name/ ├── Prompt.txt ..." (the system prompt/tree snippet) and change the
opening fence to include the language token (e.g., text) to satisfy MD040 and
improve rendering.
🧹 Nitpick comments (1)
README.md (1)
186-191: Add a guideline to preserve prompt formatting verbatim.
This aligns with repo expectations for prompt authenticity. Based on learnings, consider adding a bullet that contributors must keep original formatting, tags, and quirks intact.🧾 Suggested addition
- **Format**: Follow the existing directory and file structure +- **Preservation**: Keep original prompt formatting, tags, and quirks exactly as found - **Description**: Include clear documentation for new prompts
| ``` | ||
| Tool Name/ | ||
| ├── Prompt.txt # Main system prompt | ||
| ├── Tools.json # Available tools/functions (if applicable) | ||
| └── [Version].txt # Version-specific prompts | ||
| ``` |
There was a problem hiding this comment.
Add a language to the fenced code block.
This avoids MD040 and improves rendering.
🧾 Suggested tweak
- ```
+ ```text
Tool Name/
├── Prompt.txt # Main system prompt
├── Tools.json # Available tools/functions (if applicable)
└── [Version].txt # Version-specific prompts</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
168-168: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@README.md` around lines 168 - 173, Add a language identifier to the fenced
code block in the README excerpt so it becomes ```text instead of ```; locate
the block containing "Tool Name/ ├── Prompt.txt ..." (the system prompt/tree
snippet) and change the opening fence to include the language token (e.g., text)
to satisfy MD040 and improve rendering.
|
|
||
| --- | ||
|
|
||
| **Thank you for helping build the most comprehensive AI prompts repository! Your contributions make a real difference in how people work with AI. 🚀** |
There was a problem hiding this comment.
Promote the closing sentence to a heading.
Avoid MD036 by using a proper heading.
🧾 Suggested tweak
-**Thank you for helping build the most comprehensive AI prompts repository! Your contributions make a real difference in how people work with AI. 🚀**
+## 🙏 Thank you for helping build the most comprehensive AI prompts repository!
+Your contributions make a real difference in how people work with AI. 🚀📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Thank you for helping build the most comprehensive AI prompts repository! Your contributions make a real difference in how people work with AI. 🚀** | |
| ## 🙏 Thank you for helping build the most comprehensive AI prompts repository! | |
| Your contributions make a real difference in how people work with AI. 🚀 |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
209-209: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In `@README.md` at line 209, Change the final sentence "**Thank you for helping
build the most comprehensive AI prompts repository! Your contributions make a
real difference in how people work with AI. 🚀**" into a proper Markdown heading
(e.g., prefix with one or more '#' characters) so it becomes a heading rather
than a bare paragraph; update the README.md by replacing that closing sentence
with an appropriate heading level like "# Thank you for helping build the most
comprehensive AI prompts repository!" (you can keep the second sentence as a
subheading or sentence under it) to satisfy MD036.
Addressed CodeRabbit AI feedback: Changed "SEO Optimization" to "Search Engine Optimization" to avoid redundant acronym usage. SEO already means "Search Engine Optimization", so the previous wording was repetitive.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 138-139: The bullet for "**Search Engine Optimization**:" is
missing its description; update the README.md bullet list so the line reads "-
**Search Engine Optimization**: <concise description>" and add a short
description (e.g., mention improving visibility via on-page SEO, meta tags,
structured data, and content optimization) following the colon to match the
pattern used by the other bullets; edit the existing "Search Engine
Optimization" label rather than adding a new bullet.
♻️ Duplicate comments (2)
README.md (2)
209-209: Consider converting emphasized text to a proper heading.The closing message uses bold text which triggers MD036. Converting to a heading improves document structure.
📝 Suggested fix
-**Thank you for helping build the most comprehensive AI prompts repository! Your contributions make a real difference in how people work with AI. 🚀** +## 🙏 Thank You + +Thank you for helping build the most comprehensive AI prompts repository! Your contributions make a real difference in how people work with AI. 🚀
168-173: Add language identifier to fenced code block.The code block lacks a language identifier, which affects rendering and triggers MD040.
📝 Suggested fix
- ``` + ```text Tool Name/ ├── Prompt.txt # Main system prompt ├── Tools.json # Available tools/functions (if applicable) └── [Version].txt # Version-specific prompts</details> </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| - **Search Engine Optimization**: | ||
| - **Multi-language Support**: Translate and adapt content across languages |
There was a problem hiding this comment.
Complete the incomplete bullet point.
Line 138 has a label "Search Engine Optimization:" but is missing the description text that follows the colon. All other bullet points in this section follow the pattern "- Label: Description text".
📝 Suggested fix
-- **Search Engine Optimization**:
+- **Search Engine Optimization**: Apply AI to improve content discoverability
- **Multi-language Support**: Translate and adapt content across languages📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Search Engine Optimization**: | |
| - **Multi-language Support**: Translate and adapt content across languages | |
| - **Search Engine Optimization**: Apply AI to improve content discoverability | |
| - **Multi-language Support**: Translate and adapt content across languages |
🤖 Prompt for AI Agents
In `@README.md` around lines 138 - 139, The bullet for "**Search Engine
Optimization**:" is missing its description; update the README.md bullet list so
the line reads "- **Search Engine Optimization**: <concise description>" and add
a short description (e.g., mention improving visibility via on-page SEO, meta
tags, structured data, and content optimization) following the colon to match
the pattern used by the other bullets; edit the existing "Search Engine
Optimization" label rather than adding a new bullet.
2 participants
…elines
This PR adds two powerful sections that will help users understand and leverage the incredible value of this repository:
💡 Use Cases
Showcases real-world applications across 5 key user groups:
🤝 Contributing
Provides clear guidelines to grow this amazing community:
Why this matters: This repository is a goldmine for AI productivity. These additions will help more people discover its potential and contribute to making it even better. Together, we're building the most comprehensive AI prompts resource in the world! 🚀🌟
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.