Client side scripts guide update#12091
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project 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
|
sarah11918
left a comment
There was a problem hiding this comment.
This is fantastic @OliverSpeir !! Thank you so much for tackling this!
I've left mostly high-level comments and questions here re: the overall content (not close editing). I think what you've got is really great, and just want to find a balance of keeping some content that I still think provides some helpful context given the expected audience of some of these sections.
Comments below!
sarah11918
left a comment
There was a problem hiding this comment.
OK, next round of review comments from me! (For everyone!) 🙌
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
|
I think beside final polishing etc what's left to do is
|
|
For the sake of this PR I don't think we add the section parallel to this style page section, although I do think it should be documented somewhere/sometime, on talking and docing I got the sense that this was "reference" content and not "guide" content. For posterity the reason I think it should be documented is because Astro happens to use the from vite docs on the config option:
|
|
Also noting here that in a Discord thread we discussed the option of adding back that additional content as a recipe, as we've done for similar content:
|
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
|
Added an additional note to @sarah11918's additional notes regarding i18n. I'll be back with a full review once we are done. |
sarah11918
left a comment
There was a problem hiding this comment.
Final preview looks good to me! Just need a Final Boss @yanthomasdev review, and to make sure to add the Lunaria statement from the PR description when merging! 🎉
yanthomasdev
left a comment
There was a problem hiding this comment.
Good work here! A few suggestions from me 🙌
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@lunaria-track:src/content/docs/en/**/*.mdx -------------------------------------------------------------------------------------------------------- Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com> Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com> Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Description (required)
Essentially the goal of this PR is to "modernize" this page, making it more focused and correct.
We trim down some unnecessary examples, bring important information to the top of the page, and cut out some information that is no longer accurate and not really the docs' job to go over.
A little background on the changes:
Astro changed the way scripts work in v5 by "direct rendering" which inlines scripts and this page was written assuming that the scripts would always be externalized. Inline type module scripts do indeed block rendering, and instead of clarifying exactly how all that stuff works we cut most of it out because it's not astro specific behavior.
Related issues & labels (optional)
These changes were discussed here: #11165
Additional notes from Sarah
@lunaria-track:src/content/docs/en/**/*.mdx)