Update RavenDB hosting integration docs to reflect TypeScript AppHost support#1330
Merged
Merged
Conversation
Contributor
Author
|
@microsoft-github-policy-service agree company="RavenDB" |
Contributor
There was a problem hiding this comment.
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.jsonversion to13.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
approved these changes
Jul 6, 2026
Co-authored-by: David Pine <david.pine@microsoft.com>
…nse options for production
IEvangelist
approved these changes
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 exposeaddRavenDBor related APIs." This is no longer accurate: TypeScript AppHost support for the RavenDB integration shipped in CommunityToolkit.Aspire v13.4.0.[AspireExport]onAddRavenDB,AddDatabase, volume/bind-mount APIs, and both resource types): Add polyglot exports for ravendb CommunityToolkit/Aspire#1215This PR:
aspire.config.jsonversion example to the stable13.4.0.<Tabs syncKey="aspire-lang">, matching the conventions ofpostgres-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/modulestypings 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).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:
AddRavenDB(name)overload configures the container withRAVEN_Setup_Mode=Noneand passes no license unless one is explicitly provided viaRavenDBServerSettings.WithLicense(...).Verification
src/frontend/src/content/docs/integrations/databases/ravendb/ravendb-host.mdx.