Document Type information for Custom Events #145
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
a45d647 to
db9d49e
Compare
stof
reviewed
Dec 20, 2023
db9d49e to
ae4ad06
Compare
|
@afcapel @jorgemanrubia I've updated this branch to incorporate the new events described by #159. |
ae4ad06 to
82fcca9
Compare
jorgemanrubia
approved these changes
Feb 7, 2024
There was a problem hiding this comment.
@afcapel ok to merge this one? I'd like to reference from #160, as suggested by @seanpdoyle.
82fcca9 to
d3b96cb
Compare
d3b96cb to
dab6d1f
Compare
It appears that the team's [official stance][] is that documentation for the package's Custom Events should reside on a consumer-facing website. The documentation for Custom Events already exists, but doesn't provide particulars for the shapes of the most of the `event.details` objects. This commit brings more structure to the page, namely: * groups events by their source * promotes event names to deeply-linkable headings * adds HTML tables to describe each event's `event.detail` properties, along with type information [official stance]: hotwired/turbo#984 (comment)
dab6d1f to
88043a7
Compare
|
@jorgemanrubia this is ready for re-review. |
seanpdoyle
added a commit
to seanpdoyle/turbo-site
that referenced
this pull request
Feb 13, 2024
Follow-up to [hotwired#145][] Escape a `|` operator to avoid Markdown's confusion about whether or not its a cell separator to a character. [hotwired#145]: hotwired#145
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.
It appears that the team's official stance is that documentation for the package's Custom Events should reside on a consumer-facing website.
The documentation for Custom Events already exists, but doesn't provide particulars for the shapes of the most of the
event.detailsobjects.This commit brings more structure to the page, namely:
event.detailproperties, along with type information