Skip to content

Update RavenDB hosting integration docs to reflect TypeScript AppHost support#1330

Merged
IEvangelist merged 5 commits into
microsoft:mainfrom
idogit123:docs/ravendb-ts-apphost
Jul 8, 2026
Merged

Update RavenDB hosting integration docs to reflect TypeScript AppHost support#1330
IEvangelist merged 5 commits into
microsoft:mainfrom
idogit123:docs/ravendb-ts-apphost

Conversation

@idogit123

Copy link
Copy Markdown
Contributor

Update RavenDB hosting docs for TypeScript AppHost support

What changed

The RavenDB hosting integration page (/integrations/databases/ravendb/ravendb-host/) currently states that "The TypeScript AppHost SDK doesn't currently expose addRavenDB or related APIs." This is no longer accurate: TypeScript AppHost support for the RavenDB integration shipped in CommunityToolkit.Aspire v13.4.0.

This PR:

  1. Removes the stale caution from the TypeScript installation tab and updates the aspire.config.json version example to the stable 13.4.0.
  2. Adds TypeScript tabs (<Tabs syncKey="aspire-lang">, matching the conventions of postgres-host.mdx) to five sections: server + database, auto-create (ensureCreated), data volume, data bind mount, and log volume. All TypeScript samples were verified against the actual generated .aspire/modules typings from the v13.4.x toolkit package and are modeled on the toolkit's shipped example (examples/ravendb/CommunityToolkit.Aspire.Hosting.RavenDB.AppHost.TypeScript/apphost.mts).
  3. Keeps the secured-server section C#-only — the RavenDBServerSettings-based overload is intentionally excluded from polyglot exports ([AspireExportIgnore]), so its existing note remains unchanged.

Also: removed the "A valid RavenDB license is required" caution

This caution is inaccurate for the local-development scenario the page's examples demonstrate:

  • The default AddRavenDB(name) overload configures the container with RAVEN_Setup_Mode=None and passes no license unless one is explicitly provided via RavenDBServerSettings.WithLicense(...).
  • The toolkit's own C# and TypeScript example AppHosts run entirely license-free, and the toolkit's CI integration tests (which wait for the RavenDB resource's health check to pass) succeed without a license.

Verification

  • Rendered locally with the Astro dev server: tabs display and language-sync correctly on all five sections; no MDX build errors.
  • Diff touches only src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx.

Copilot AI review requested due to automatic review settings July 6, 2026 07:57
@idogit123

Copy link
Copy Markdown
Contributor Author

@microsoft-github-policy-service agree company="RavenDB"

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the RavenDB hosting integration documentation to reflect TypeScript AppHost support in the Community Toolkit integration, replacing prior guidance that TypeScript APIs weren’t available and adding TypeScript samples alongside existing C# ones.

Changes:

  • Updates the TypeScript installation tab to remove the “no TypeScript support” caution and pins the example aspire.config.json version to 13.4.0.
  • Adds <Tabs syncKey="aspire-lang"> sections with TypeScript examples for server+database, ensureCreated, data volume, data bind mount, and log volume scenarios.
  • Removes the “valid RavenDB license is required” caution block from the page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@IEvangelist IEvangelist left a comment

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.

Clean up await usage.

Comment thread src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx Outdated
Comment thread src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx Outdated
Comment thread src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx Outdated
Comment thread src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx Outdated
Comment thread src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx Outdated
@IEvangelist IEvangelist enabled auto-merge (squash) July 8, 2026 11:32
@IEvangelist IEvangelist merged commit b294a19 into microsoft:main Jul 8, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants