Improve documentation #530
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
brunoprietog
force-pushed
the
docs-improvements
branch
2 times, most recently
from
0e61120
to
56122d6
Compare
brunoprietog
force-pushed
the
docs-improvements
branch
from
56122d6
to
2d885a7
Compare
There was a problem hiding this comment.
Great one @brunoprietog. There is a committed merge conflict. If you fix that I'll merge. Thanks!
brunoprietog
force-pushed
the
docs-improvements
branch
from
2d885a7
to
8fe047d
Compare
Co-authored-by: Jorge Manrubia <jorge.manrubia@gmail.com>
jorgemanrubia
approved these changes
Feb 7, 2024
afcapel
added a commit
that referenced
this pull request
Feb 8, 2024
* origin/main: Improve documentation (#530)
This was referenced Feb 8, 2024
brunoprietog
commented
Feb 9, 2024
| # You can broadcast "page refresh" stream actions. This will make subscribed clients reload the | ||
| # page. For pages that configure morphing and scroll preservation, this will translate into smooth | ||
| # updates when it only updates the content that changed. | ||
|
|
There was a problem hiding this comment.
Hey @jorgemanrubia, this blank line is causing everything above not to show. I've opened #571 to fix this and other small minor details that I missed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, for newcomers, it is difficult to find the appropriate documentation to understand the value of turbo-rails and discover what it is capable of. If they reach RDoc, it is not intuitive to identify which classes and modules are responsible for the specific behavior of each part of turbo-rails oriented towards developers. We should make this information more visible to make it easier to get started.
This PR includes several typo corrections, suggestions from #516 and #524, documentation for some undocumented methods, and some explanations about page refreshes.
Additionally, in the README, the most important links to RDoc are included to make it easier to find and read the documentation.
Please, I would love to receive feedback.