Update README.md #2267
Update README.md #2267
Conversation
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.
|
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
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:
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? 🤔 |
There was a problem hiding this comment.
As mentioned in my comment, the current edits removes all formatting. Please add at least the following:
- headers for sections,
- bullet points,
- clickable links,
- usage of other formatting options (bold, italic) where necessary
Once done, please ping me and I will perform a deeper review.
pwizla
added
pr: updated content
|
Hi @anuragdotexe, have you had the chance to look at our requested changes and move forward with this PR? |
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