Skip to content

Added tip for Actions#10190

Merged
sarah11918 merged 7 commits into
withastro:mainfrom
hkbertoson:add/update-actions
Dec 5, 2024
Merged

Added tip for Actions#10190
sarah11918 merged 7 commits into
withastro:mainfrom
hkbertoson:add/update-actions

Conversation

@hkbertoson
Copy link
Copy Markdown
Contributor

Description (required)

Added a tip for Actions regarding how data is sent back.

Related issues & labels (optional)

  • Closes #
  • Suggested label: improve documentation

@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 4, 2024

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a43236b
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/6751be65ad6fd5000807a0e0
😎 Deploy Preview https://deploy-preview-10190--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Dec 4, 2024

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/actions.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Contributor

@bholmesdev bholmesdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some thoughts on wording. Thanks for taking action on this!

Comment thread src/content/docs/en/guides/actions.mdx Outdated
Co-authored-by: Ben Holmes <hey@bholmes.dev>
@hkbertoson
Copy link
Copy Markdown
Contributor Author

Got it updated!

Comment thread src/content/docs/en/guides/actions.mdx Outdated
Comment thread src/content/docs/en/guides/actions.mdx Outdated
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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! 🙌

@hkbertoson
Copy link
Copy Markdown
Contributor Author

I like the change. I think it does make sense where its at and fits the "flow" better.

@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels Dec 5, 2024
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! Let's get this into docs!

@sarah11918 sarah11918 merged commit 3851215 into withastro:main Dec 5, 2024
@hkbertoson hkbertoson deleted the add/update-actions branch December 5, 2024 15:09
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Dec 5, 2024
yanthomasdev added a commit that referenced this pull request Dec 5, 2024
…10139)

* i18n(fr): update `guides/actions.mdx` & `modules/astro-actions.mdx`

See #9240

* fix anchor, missing hyphen

* complete Handling returned data section

See #10190

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants