strapi / documentation

Strapi Documentation
https://docs.strapi.io
Other
1.03k stars 1.13k forks source link

Update README.md #2267

Closed anuragdotexe closed 4 days ago

anuragdotexe commented 1 month ago

What’s New: Gave the Strapi docs a proper refresh to make things clearer, easier to navigate, and more helpful for both new users and seasoned devs. Cleaned up some clutter, broke down key sections better, and added practical tips so contributors can jump in without a hitch.

Key Tweaks:

Simplified Intro:

Reworked the intro to quickly explain what Strapi is and why it rocks. Highlighted key benefits—control over data, flexible hosting, database support, and full customization. Streamlined Navigation:

Grouped docs by versions with short descriptions on which ones are maintained and which are legacy. Contributor Guide Love:

Sharpened up the steps for contributing—clear requirements (Node.js, NPM, Yarn) and an easy-to-follow guide for pull requests. Better Help Resources:

Added clear pathways for help (forum, Discord, GitHub) and linked to video tutorials and community spaces. Release & Versioning Explained:

Explained the independent versioning starting from Strapi 5 and how updates roll out weekly. Tidied Up Layout:

Made things readable with bullet points, headers, and snappier sentences to help devs find what they need fast. Why This Matters:

For Newbies: Quick understanding, smoother onboarding. For Contributors: Easier to jump in and make meaningful contributions. For Everyone: A cleaner, more enjoyable read that matches the Strapi vibe.

What does it do?

Describe the technical changes you did.

Why is it needed?

Describe the issue you are solving.

Related issue(s)/PR(s)

Let us know if this is related to any issue/pull request

strapi-cla commented 1 month ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

vercel[bot] commented 1 month ago

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 Oct 19, 2024 9:43am
pwizla commented 1 month ago

Hi @anuragdotexe,

Thank you very much for your suggestion. I appreciate the effort! However, in its current state, your suggested revision is IMHO less readable and does not deserve the purpose you declared 😅 Quoting you from the PR description:

Tidied Up Layout: Made things readable with bullet points, headers, and snappier sentences to help devs find what they need fast.

Please see it for yourself here 😊 https://github.com/anuragdotexe/documentation/blob/patch-1/README.md

There are no headers and no bullet points. Is this what you intended? 🤔

pwizla commented 1 week ago

Hi @anuragdotexe, have you had the chance to look at our requested changes and move forward with this PR?

pwizla commented 4 days ago

This PR appears stale. I will close it for now. Feel free to reopen if you want to tackle the suggestions asked in this comment.