Skip to content

[test] Yet another PR for "12 rules" review automated validation #2567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

pwizla
Copy link
Collaborator

@pwizla pwizla commented Jun 27, 2025

πŸ€–πŸ‘€πŸ•΅οΈβŒβœ…

@pwizla pwizla requested a review from meganelacheny as a code owner June 27, 2025 11:37
@pwizla pwizla self-assigned this Jun 27, 2025
Copy link

vercel bot commented Jun 27, 2025

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
documentation βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jun 27, 2025 3:52pm

@pwizla pwizla added the flag: don't merge This PR should not be merged at the moment label Jun 27, 2025
Copy link

πŸ‘‹ Thanks for contributing to Strapi's documentation!

I've reviewed the changes in your file, and here's what I found:

Your contribution looks great! I've spotted 1 small improvement that will make your documentation even better.

πŸ“Š Quick Overview:
🚨 1 critical item to address

I've added 1 detailed comment directly on the relevant lines with specific suggestions and examples.

The critical items are quick fixes that ensure our documentation is welcoming to all skill levels. These improvements will make your contribution even more helpful for the Strapi community!

πŸ“š Helpful Resources:
πŸ“– Strapi's 12 Rules of Technical Writing
🎨 Documentation Style Guide


πŸ€– This review focuses only on the lines you've changed. Questions? Feel free to ask in the comments!

πŸ”§ Manually triggered validation for PR #2567

Copy link

πŸ“ Detailed Suggestions

Unable to post inline comments, here are the specific suggestions:

docs/cms/features/admin-panel.md:14

🚨 Strapi Documentation Review

🎯 Rule 6 - Avoid "easy/difficult" language

CRITICAL: Never use "easy" - it can discourage readers (Rule 6)

πŸ’‘ Suggestion: Remove subjective difficulty assessment and provide clear instructions instead

✨ Example:
❌ "This is easy to configure"
βœ… "To configure this setting:"

πŸ“š Learn more about our writing guidelines


@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
@strapi strapi deleted a comment from github-actions bot Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
flag: don't merge This PR should not be merged at the moment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant