Skip to content

fix: add reassign keyword to Dynamic Tags section in astro-syntax.mdx#9082

Merged
yanthomasdev merged 4 commits intowithastro:mainfrom
ArmandPhilippot:fix/astro-syntax-dynamic-tag-reassign
Aug 14, 2024
Merged

fix: add reassign keyword to Dynamic Tags section in astro-syntax.mdx#9082
yanthomasdev merged 4 commits intowithastro:mainfrom
ArmandPhilippot:fix/astro-syntax-dynamic-tag-reassign

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 14, 2024

This PR is a follow-up to Erika's issue on Discord:

I was searching for "reassignement" and "hydration" but couldn't find anything

The Dynamic Tags section shows an example of a reassignment but this keyword does not appear so we cannot find the page using the search form. This keyword is important since a reassigned component cannot use client: directives.

With "hydration" the page appears and I don't think we can improve the excerpt (we can't guess what the user hopes to find by using this keyword, this could be in another context).

So this PR will help make the page stand out in search results using the "reassignment" keyword.

Description (required)

  • Rewords the first sentence in Dynamic tags section to help find the page using reassignment in the search form.
  • Fixes a typo when escaping the style attribute in the define:vars bullet point: the double backtick must be around style, not inside. (Typo introduced by... me, sorry 😅 ... my first PR here 🎉 )

I don't know if that's enough. I never used Algolia so I don't know how it handles keywords. I'm not sure if this would work with reassigning or reassigned as well. Currently, using reassignment or reassigning does not display pages containing reassigned.

So I'm not sure we can support all variants but this should work with reassign and reassignment.

Question: Is there a way to generate and use a local index with Algolia? I wanted to test on the dev version, but it seems my changes don't affect the search form so I guess this is a shared index with the production version.

Related issues & labels (optional)

@netlify
Copy link
Copy Markdown

netlify bot commented Aug 14, 2024 •
edited
Loading

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 52c59fc
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/66bce47b86c35300088b8034
😎 Deploy Preview https://deploy-preview-9082--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 Aug 14, 2024 •
edited
Loading

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

Locale File Note
en basics/astro-syntax.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.

@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Aug 14, 2024

This looks great! I think it will work nicely.

Question: Is there a way to generate and use a local index with Algolia? I wanted to test on the dev version, but it seems my changes don't affect the search form so I guess this is a shared index with the production version.

No, and in fact, we need to reindex Algolia manually to see any updates even in live docs (other than the regular weekly crawls) so you were never going to be able to test that. 😄

@sarah11918 sarah11918 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Aug 14, 2024
sarah11918
sarah11918 approved these changes Aug 14, 2024
View reviewed changes
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 so much, looks great!

@sarah11918 sarah11918 added feedback-improvement Response to widget/Discord feedback Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! labels Aug 14, 2024
@ArmandPhilippot
Copy link
Copy Markdown
Member Author

ArmandPhilippot commented Aug 14, 2024

No, and in fact, we need to reindex Algolia manually to see any updates even in live docs (other than the regular weekly crawls) so you were never going to be able to test that. 😄

Ah ok, I thought there was a reindex triggered at build time (but not locally... I tested it just in case 😅 ). Thanks for the explanation!

yanthomasdev
yanthomasdev approved these changes Aug 14, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

LGTM!

@yanthomasdev yanthomasdev merged commit abbaefd into withastro:main Aug 14, 2024
@ArmandPhilippot ArmandPhilippot deleted the fix/astro-syntax-dynamic-tag-reassign branch August 14, 2024 17:22
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Aug 14, 2024
@ArmandPhilippot
i18n(fr): update basics/astro-syntax.mdx
1f17b8f 
Apply changes from withastro#9082
@ArmandPhilippot ArmandPhilippot mentioned this pull request Aug 14, 2024
Merged
dreyfus92 pushed a commit that referenced this pull request Aug 14, 2024
@ArmandPhilippot
i18n(fr): update basics/astro-syntax.mdx (#9087)
cc98a01 
Apply changes from #9082
@Nin3lee Nin3lee mentioned this pull request Aug 15, 2024
Merged
@jsparkdev jsparkdev mentioned this pull request Aug 15, 2024
Merged
trueberryless added a commit to trueberryless/withastro-docs that referenced this pull request Oct 30, 2024
@trueberryless
update translation withastro#9082
379d6c5
@trueberryless trueberryless mentioned this pull request Oct 30, 2024
Merged
yanthomasdev added a commit that referenced this pull request Nov 4, 2024
@trueberryless @yanthomasdev
i18n(de): update basics/astro-syntax.mdx (#9886)
c22591c 
* update translation #5364

* update translation #5572

* update translation #8585

* update translation #9082

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@vrabe vrabe mentioned this pull request Feb 11, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sarah11918 sarah11918 sarah11918 approved these changes

@yanthomasdev yanthomasdev yanthomasdev approved these changes

Assignees

No one assigned

Labels

feedback-improvement Response to widget/Discord feedback improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)!

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ArmandPhilippot @astrobot-houston @sarah11918 @yanthomasdev