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
Update readme 2022 #3131
Update readme 2022 #3131
Conversation
…more convenience commands
* master: Contents Rename Modal, use `id` Widget type, Add `id` as widget type … (#3127)
✔️ Deploy Preview for volto ready! 🔨 Explore the source changes: b46ba32 🔍 Inspect the deploy log: https://app.netlify.com/sites/volto/deploys/6228e6009b29b800090cc254 😎 Browse the preview: https://deploy-preview-3131--volto.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few English syntax and grammar things, and a few MyST syntax things.
I might suggest simplifying the README by moving content from it into the docs, and linking to the docs. It's a pretty long readme.
@@ -222,14 +216,14 @@ JavaScript-centered trainings. | |||
|
|||
## Browser support | |||
|
|||
Volto works well with any modern (and updated) browser, including their mobile | |||
Volto works well with any modern (evergreen) browser, including their mobile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does "evergreen" mean? I've never heard that term used for a web browser, but only for trees and shrubbery.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems it's a trendy word now... I've already seen it in a number of places refers to those browsers that are automatically updated... so all modern browsers.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"modern browser" would do IMHO.
Co-authored-by: Steve Piercy <web@stevepiercy.com>
@stevepiercy Thanks for watching over my crappy English Grammar :P |
What sections would you move to the docs? I guess all is about quick tips and directions for newbies, so the README contains all the necessary to quick start and make themselves an idea of what to expect, and try Plone 6 quickly. I'm open to it, but I think we could do it later, after Volto 15 is released. |
I think a hint to the ecosystem of add-ons via a link to "Awesome Volto" https://github.com/collective/awesome-volto would be beneficial. |
@ksuess I included it already: |
Anything that already exists in the docs should be removed and linked to. Keep it DRY. Other than that, if the part becomes too "document-ish", then it probably belongs in the docs. That's a subjective call. It might be best to create a Quick Start Guide.
I totally agree. Shall I make a new issue to track it? |
I wanted to update it before releasing Volto 15.