Update bit Boilerplate docs regarding azure cloud features (#11949)

[ysmoradi]

closes #11949

Summary by CodeRabbit

• Documentation
  • Added guidance on migrating from local containers to Azure managed services in .NET Aspire projects.
  • Added performance optimization documentation for vector search using Azure DiskANN indexing and reranking strategies.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Two documentation files in the Bit.Boilerplate project have been updated with new sections covering Azure cloud migration and optimization. The .NET Aspire.md file now includes guidance on migrating from local containers to Azure managed services. The RAG semantic search documentation has been expanded with a detailed performance optimization section covering DiskANN indexing and reranking strategies for PostgreSQL vector searches.

Changes

Cohort / File(s)

Summary

Azure Migration & Vector Search Documentation src/Templates/Boilerplate/Bit.Boilerplate/.docs/20- .NET Aspire.md, src/Templates/Boilerplate/Bit.Boilerplate/.docs/25- RAG - Semantic Search with Vector Embeddings (Advanced).md

Added two new documentation sections: (1) "Going Production: Switching to Azure Managed Services" covering prerequisites, AppHost.cs updates, and examples for Azure SQL, Azure Redis, and PostgreSQL Flexible Server; (2) "7. Performance Optimization: Azure DiskANN index & Reranking" detailing PostgreSQL extension configuration, DiskANN index setup with vector(384) and disk-ANN-specific options, and recommended reranking query strategies for optimized vector search

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Azure paths now gently light,
With DiskANN's vectors shining bright,
Production clouds and indexes fine,
Our docs now help you cross the line!
From local hops to managed skies, ☁️

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Update bit Boilerplate docs regarding azure cloud features' directly and clearly describes the main change - documentation updates related to Azure cloud features in the Boilerplate.
Linked Issues check	✅ Passed	The pull request updates documentation sections covering Azure managed services migration and advanced vector search optimization with DiskANN, fully addressing the objective to update Boilerplate docs regarding Azure cloud features.
Out of Scope Changes check	✅ Passed	All changes are confined to documentation files (.md) in the Boilerplate project, specifically adding Azure-related content (managed services and DiskANN optimization) that are directly aligned with the PR objective.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between a6d67cb and 28d19c2.

📒 Files selected for processing (2)

• src/Templates/Boilerplate/Bit.Boilerplate/.docs/20- .NET Aspire.md
• src/Templates/Boilerplate/Bit.Boilerplate/.docs/25- RAG - Semantic Search with Vector Embeddings (Advanced).md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: build Bit.Templates

🔇 Additional comments (4)

src/Templates/Boilerplate/Bit.Boilerplate/.docs/20- .NET Aspire.md (2)

336-400: Well-structured Azure migration guide.

The new "Going Production" section provides clear, step-by-step guidance for migrating from local containers to Azure managed services. The structure is logical (prerequisites → examples for each service), and the code snippets clearly show the pattern of switching from local to managed equivalents.

---

336-400: No duplication detected—the section "## ☁️ Going Production: Switching to Azure Managed Services" appears only once in the document.

src/Templates/Boilerplate/Bit.Boilerplate/.docs/25- RAG - Semantic Search with Vector Embeddings (Advanced).md (2)

353-447: Comprehensive DiskANN performance guide with clear before/after examples.

The new section provides valuable production optimization guidance with:

• Clear prerequisite steps (enabling extensions and configuring index)
• Concrete before/after query examples showing the two-step reranking pattern
• Explanation of why the approach matters (compression compensation, accuracy improvement)
• Reference to official Microsoft documentation for further details

The use of database-appropriate types (Pgvector.Vector for PostgreSQL examples) correctly aligns with the section's PostgreSQL focus, and the LINQ patterns are clear and idiomatic.

---

353-447: No duplication found. The section "## 7. Performance Optimization: Azure DiskANN index & Reranking" appears exactly once in the document and does not require deduplication.

Likely an incorrect or invalid review comment.