Added tip for Actions#10190
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
bholmesdev
left a comment
There was a problem hiding this comment.
Some thoughts on wording. Thanks for taking action on this!
Co-authored-by: Ben Holmes <hey@bholmes.dev>
|
Got it updated! |
There was a problem hiding this comment.
Thank you for submitting this helpful update @hkbertoson ! 🎉
See what you think of the new placement of the content I'm suggesting here.
Notably:
- it was previously at the VERY BEGINNING, the FIRST THING SOMEONE READ, even before how to use an action. I don't think you meant for this to be of such supreme importance that someone cannot continue without knowing that info first? That is why I've moved it lower.
- Whenever new content is "how something works", it's typically not a note, tip, caution etc. It's part of the description/explanation. We typically use a "note" for true and helpful, related but maybe slightly off the immediate topic information that might trip you up if you don't know it. (But, this isn't really the place to document it.) A tip is a non-essential but helpful thing you could do (an action). In some worlds, this is a tip, since you're suggesting inspecting the data object. But given that the alternative is described as "difficult" (and not the happy path), this feels less "optional" and more like "how it should be done." To me, that's regular paragraph text and not a "tip you might want to consider."
- The biggest task for incorporating new content into existing docs is to find out where it should really go. In this case, since it provides more context for the data object returned, and provides a link to the
handler()API reference for more details, it seemed like it fit in the section about "handling returned data." This has the added benefit of existing somewhere close to a direct anchor link that's related to the content. Do you think this is the right place for it? Is there somewhere better?
So see what you think of my suggestion here, whether it's accurate (you're the subject matter expert here!), helpful, and seems to fit in this section. Make any suggestions you need to if it's not quite right yet! 🙌
|
I like the change. I think it does make sense where its at and fits the "flow" better. |
sarah11918
left a comment
There was a problem hiding this comment.
Great stuff! Let's get this into docs!
Description (required)
Added a tip for Actions regarding how data is sent back.
Related issues & labels (optional)