Skip to content

Update docs for new AstroDB update#12208

Merged
florian-lefebvre merged 4 commits into
withastro:mainfrom
Adammatthiesen:astro-db-update
Sep 17, 2025
Merged

Update docs for new AstroDB update#12208
florian-lefebvre merged 4 commits into
withastro:mainfrom
Adammatthiesen:astro-db-update

Conversation

@Adammatthiesen
Copy link
Copy Markdown
Member

Description (required)

Updates docs for the new Astro DB update withastro/astro#14204

Related issues & labels (optional)

  • Closes #
  • Suggested label:

@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 25, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 99e809d
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/68adf4425501c2000801f21d
😎 Deploy Preview https://deploy-preview-12208--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 project configuration.

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Aug 25, 2025

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/astro-db.mdx Source changed, localizations will be marked as outdated.
en/guides/integrations-guide/db.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 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" = approved for merging on release day. labels Aug 25, 2025
@sarah11918 sarah11918 added this to the 5.14.0 milestone Aug 25, 2025
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.

Thanks for the docs, @Adammatthiesen ! And the amazing feature that I think such an improvement to DB! See my comments below for polishing the text!

(And try not to laugh too hard at all the things I made up so that I'd have an example of what I think things could sound like! 😅 )

Comment thread src/content/docs/en/guides/astro-db.mdx Outdated
:::note
While remote connections are generally possible with any deployment platform using static or server rendering mode, there are currently some limitations. Non-Node runtimes like Cloudflare and Deno don't currently support DB on server-rendered routes when using libSQL. Support for these platforms is planned for future implementation.
:::
#### Non-Node Environments
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This heading actually splits off the regular instructions for connecting to remote databases and instead puts it under this sub heading!

The note was here previously to let people know when to not even bother continuing on to follow the instructions. But this information doesn't serve that same purpose now, so we have to think about where it belongs.

If the instructions are the same for both modes, then I think we can go straight into "configure your build command" and move your newer content down closer to, and maybe even inside this paragraph:

The --remote flag uses the connection to the remote DB both locally during the build and on the server. Ensure you set the necessary environment variables in both your local development environment and your deployment platform.

Like, maybe this is now:

The --remote flag uses the connection to the remote DB both locally during the build and on the server. Ensure you set the necessary environment variables in both your local development environment and your deployment platform. Additionally, you may need to configure web mode for non-Node.js runtimes such as Cloudflare Workers or Deno.

If we just said that, and linked to the config docs, are we missing any key info?

Comment thread src/content/docs/en/guides/integrations-guide/db.mdx
Comment thread src/content/docs/en/guides/integrations-guide/db.mdx Outdated
Comment thread src/content/docs/en/guides/integrations-guide/db.mdx Outdated
});
```

:::note
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

See my comment above, I'd remove this note in favour of more fully explaining the two modes themselves.

Adammatthiesen and others added 2 commits August 25, 2025 13:16
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
@Adammatthiesen
Copy link
Copy Markdown
Member Author

Adammatthiesen commented Aug 25, 2025

@sarah11918 I think i've got everything 😅 (still not a writer 😅 )

Comment thread src/content/docs/en/guides/integrations-guide/db.mdx
Comment thread src/content/docs/en/guides/astro-db.mdx
Comment thread src/content/docs/en/guides/integrations-guide/db.mdx Outdated
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
@sarah11918 sarah11918 added the Merge Queue Approved and ready to be merged (wait for feature release if also labelled M-O-R)! label Aug 27, 2025
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.

LGTM, great job @Adammatthiesen ! 🙌

You can merge this as soon as the next @astrojs/db minor is released. I'll try to keep an eye out for it too.

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

Copy link
Copy Markdown
Contributor

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

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

LGTM!

@florian-lefebvre florian-lefebvre merged commit b304bbd into withastro:main Sep 17, 2025
10 checks passed
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Sep 18, 2025
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)! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" = approved for merging on release day.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants