Removed unnecessary words from Getting Started docs #37946
Conversation
Using "simple" and "just" in documentation is very tempting! It is there to show enthusiasm and to encourage new people to try out the thing the author loves. In this case, Rails. However, if you are following documentation and struggle with it, reading these words can be a source of frustration. Also: using fewer words can make the instructions more clear and can reduce ambiguity.
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. |
| @@ -525,7 +525,6 @@ method called `form_with`. To use this method, add this code into | |||
| ``` | |||
|
|
|||
| If you refresh the page now, you'll see the exact same form from our example above. | |||
| Building forms in Rails is really just that easy! | |||
There was a problem hiding this comment.
Wouldn't it make more sense to keep this as "Building forms in Rails is really easy!" I've seen how other technologies are used to build forms and I can guarantee you that it's definitely a lot easier to build forms in Rails than in any other framework out there. We could even say that "Building forms in Rails is fast and straightforward".
There was a problem hiding this comment.
It's not easy if you have never done any programming before and the audience of a Getting Started page is more likely to be new programmers than seasoned switchers from another framework. ref: https://justsimply.dev
There was a problem hiding this comment.
Maybe it would be more precise to say that it needs less typing. A lot of the Magic of Rails™️ amounts to not having to type 500 characters where 50 would do.
|
Thanks, for the code and reviews people! Ended up looking at this again and didn't think it was worth the extra rounds to shuffle more things around. It's overall better, so let's use it. |
[ci skip]
Summary
This PR removes some uses of "simple" and "just" from the getting started documentation.
Other Information
Using "simple" and "just" in documentation is very tempting! It is there to show enthusiasm and to encourage new people to try out the thing the author loves. In this case, Rails. However, if you are following documentation and struggle with it, reading these words can be a source of frustration.
Also: using fewer words can make the instructions more clear and can reduce ambiguity.