fix(5.0.0): nitpicking and suggestions regarding `on-demand-rendering.mdx` by ArmandPhilippot · Pull Request #9673 · withastro/docs

ArmandPhilippot · 2024-10-14T21:58:05Z

Description (required)

Typo fix (every)
Updates some code snippet due to some concerns about highlighting (I only updated from the previous/next example but maybe all examples should use the same format: either simple highlighting or ins)
Updates the file name of a code snippet because the usage of Astro.params seemed wrong otherwise
Adds a suggestion regarding Astro.redirect in Response subsection

Related issues & labels (optional)

Suggested label: 5.0, 5.0.0-beta, code snippet update

netlify · 2024-10-14T21:58:20Z

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`686647d`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/670fbc910dcbb70008a5c6fa
😎 Deploy Preview	https://deploy-preview-9673--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

ArmandPhilippot · 2024-10-14T21:59:51Z

 The following example shows opting out of prerendering in order to display a random number each time the endpoint is hit:

-```js title="src/pages/randomnumber.js" {1}
+```js title="src/pages/randomnumber.js" ins={1}


nit: The previous example use ins={2}, shouldn't we use the same visual information here? (or the other way around... not covered by my suggestion)

ArmandPhilippot · 2024-10-14T22:01:23Z

 Then, if needed, you can choose to prerender any individual pages that do not require a server to execute, such as a privacy policy or about page.

-```astro title="src/pages/about-my-app.astro"
+```astro title="src/pages/about-my-app.astro" {2}


Same concern here about the highlighting. The next example uses "highlighting" but we don't use it here. Maybe we should use ins here and in the next example too? (I just updated from the next example)

Sure, let's make them all ins!

astrobot-houston · 2024-10-14T22:01:24Z

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	guides/on-demand-rendering.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.

ArmandPhilippot · 2024-10-14T22:02:23Z

+The example below sets a response status and status text for a product page when the product does not exist:

-```astro title="src/pages/my-product.astro" {10,11}
+```astro title="src/pages/product/[id].astro" {10,11}


From my understanding, Astro.params only works with path segments (e.g. [id]). See Astro.params (besides on this page, I wonder if the example should not be above the sentence related to SSR...)

Sorry, where would you place this example?

To avoid any confusion I am talking about the example in the section Astro.params.
Sorry, I didn't detail as it's not related to this PR, it's just by checking Astro.params that I thought the location of the example seemed strange.
The example shows the use of getStaticPaths which is usable with static builds while the sentence just above talks about SSR builds. So what would seem more logical to me would be between the two sentences (In static builds,... > getStaticPaths example > In SSR builds, ...).
But thinking back, I guess that was to avoid isolating the "SSR builds" sentence.

Ah, gotcha now, thanks! Yes, I see what you mean. I think it could be helpful on that page to also have an SSR example maybe? And then yes, the example there above the SSR sentence, which itself gets its own example?

I almost forgot about this comment, sorry. Yes I think it would be useful to show both uses here. 💯 I'm going to prepare a PR.

ArmandPhilippot · 2024-10-14T22:04:51Z

 The example below returns a 404 on a dynamic page after looking up an ID in the database:

-```astro title="src/pages/[id].astro" {10-13}
+```astro title="src/pages/product/[id].astro" {10-13}


I only updated because that's the path I had used before... it wasn't really a problem, just a matter of consistency.

Co-authored-by: Matthew Justice <72817096+JusticeMatthew@users.noreply.github.com>

sarah11918

Thank you @ArmandPhilippot these changes look great to me! I made one ins suggestion where I could, and pointed out the one where I couldn't. But happy with this!

I will say, for the changes to the "Features" sections, which is basically copied from the existing server-side-rendering page in main branch, you can feel free to PR them to that page directly too, and this will let the translators work on that updated content in advance of this branch merging eventually. That would make that merge more just "copy paste" of that entire Features section, which I really hadn't intended to change here!

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

ArmandPhilippot · 2024-10-16T13:16:29Z

Thanks for your feedback @sarah11918! I'm going to make a PR to update the current doc! 🫡

sarah11918 · 2024-10-16T13:17:48Z

!coauthor

ArmandPhilippot added 2 commits October 14, 2024 23:47

fix(5.0.0): nitpicking on on-demand-rendering.mdx

11d5b06

add subsection regarding redirect with on demand rendering

7f0c27e

github-actions Bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Oct 14, 2024

ArmandPhilippot changed the base branch from main to 5.0.0-beta October 14, 2024 21:58

ArmandPhilippot commented Oct 14, 2024

View reviewed changes

Comment thread src/content/docs/en/guides/on-demand-rendering.mdx Outdated

move redirect example in a return a response object

98be3b3

Co-authored-by: Matthew Justice <72817096+JusticeMatthew@users.noreply.github.com>

github-actions Bot removed the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Oct 15, 2024

sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. 5.0.0-beta labels Oct 15, 2024

sarah11918 reviewed Oct 16, 2024

View reviewed changes

Comment thread src/content/docs/en/guides/on-demand-rendering.mdx Outdated

sarah11918 approved these changes Oct 16, 2024

View reviewed changes

ArmandPhilippot and others added 3 commits October 16, 2024 15:12

add ins attribute to code snippet

d60d21b

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

add second ins attribute to code snippet

8affc9d

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

Merge branch '5.0.0-beta' into guides/on-demand-rendering-suggestions

686647d

sarah11918 merged commit 5985401 into withastro:5.0.0-beta Oct 16, 2024

ArmandPhilippot mentioned this pull request Oct 16, 2024

update a code snippet in guides/server-side-rendering.mdx #9700

Merged

ArmandPhilippot deleted the guides/on-demand-rendering-suggestions branch October 16, 2024 13:23

ArmandPhilippot mentioned this pull request Oct 16, 2024

fix(api-reference): add a code snippet for Astro.params with SSR #9702

Merged

Uh oh!

Conversation

ArmandPhilippot commented Oct 14, 2024

Description (required)

Related issues & labels (optional)

Uh oh!

netlify Bot commented Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for astro-docs-2 ready!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

astrobot-houston commented Oct 14, 2024

Lunaria Status Overview

Tracked Files

Uh oh!

ArmandPhilippot Oct 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sarah11918 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArmandPhilippot commented Oct 16, 2024

Uh oh!

sarah11918 commented Oct 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify Bot commented Oct 14, 2024 •

edited

Loading

ArmandPhilippot Oct 14, 2024 •

edited

Loading

sarah11918 left a comment •

edited

Loading