Add comprehensive DTFx documentation #1299
Open
+9,292
−12
Conversation
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
- Add getting-started guides (installation, quickstart, choosing-a-backend) - Add core concepts documentation (orchestrations, activities, replay, determinism) - Add feature documentation (timers, events, retries, sub-orchestrations, etc.) - Add backend provider documentation (Durable Task Scheduler, Azure Storage, MSSQL, etc.) - Add advanced topics (middleware, entities, serialization, testing) - Add telemetry documentation (distributed tracing, Application Insights, logging) - Add samples catalog and README files for sample projects - Update root README.md to link to documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the Durable Task Framework (DTFx) for .NET. The documentation provides a complete reference covering installation, core concepts, features, backend providers, telemetry, advanced topics, and sample catalogs.
Changes:
- Added extensive documentation across getting started, concepts, features, providers, telemetry, and advanced topics
- Created README files for sample projects with usage instructions and code examples
- Added support documentation explaining community vs enterprise support options
Reviewed changes
Copilot reviewed 42 out of 42 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| samples/ManagedIdentitySample/README.md | Documents Azure Managed Identity authentication setup for v1.x and v2.x Azure Storage providers |
| samples/DurableTask.Samples/README.md | Comprehensive guide to core sample orchestrations with code examples and command-line usage |
| samples/DistributedTraceSample/README.md | Overview of distributed tracing samples for OpenTelemetry and Application Insights |
| samples/DistributedTraceSample/ApplicationInsights/README.md | Setup guide for Application Insights integration sample |
| samples/Correlation.Samples/Readme.md | Documents legacy correlation-based distributed tracing approach |
| docs/telemetry/logging.md | Complete logging configuration guide with examples for orchestrations and activities |
| docs/telemetry/distributed-tracing.md | Distributed tracing setup with OpenTelemetry and Application Insights integration |
| docs/telemetry/application-insights.md | Deep Application Insights integration guide with queries and best practices |
| docs/support.md | Explains community vs enterprise support models and security reporting |
| docs/samples/catalog.md | Catalog of available sample projects with feature descriptions |
| docs/providers/service-fabric.md | Service Fabric provider configuration and architecture documentation |
| docs/providers/service-bus.md | Service Bus provider setup with managed identity support |
| docs/providers/mssql.md | MSSQL provider reference pointing to external repository |
| docs/providers/emulator.md | In-memory emulator provider for local development |
| docs/providers/durable-task-scheduler.md | Comprehensive guide for the recommended managed Azure service |
| docs/providers/custom-provider.md | Guide for implementing custom storage providers |
| docs/providers/azure-storage.md | Detailed Azure Storage provider documentation with architecture diagrams |
| docs/providers/README.md | Provider comparison table and recommendations |
| docs/getting-started/quickstart.md | Step-by-step tutorial for first orchestration |
| docs/getting-started/installation.md | Package installation guide for all providers |
| docs/getting-started/choosing-a-backend.md | Comprehensive provider comparison and selection guide |
| docs/features/versioning.md | Orchestration versioning strategies and safe code changes |
| docs/features/timers.md | Durable timer patterns and best practices |
| docs/features/sub-orchestrations.md | Sub-orchestration patterns and error handling |
| docs/features/retries.md | Automatic retry configuration and patterns |
| docs/features/external-events.md | External event patterns with OnEvent implementation |
| docs/features/eternal-orchestrations.md | ContinueAsNew pattern for long-running workflows |
| docs/features/error-handling.md | Exception handling, compensation patterns, and error propagation modes |
| docs/features/README.md | Features overview and navigation |
| docs/concepts/replay-and-durability.md | Event sourcing model and replay mechanics explanation |
| docs/concepts/orchestrations.md | Orchestration patterns and OrchestrationContext API reference |
| docs/concepts/deterministic-constraints.md | Determinism requirements and common pitfalls |
| docs/concepts/core-concepts.md | Architecture overview of Task Hubs, Workers, and Clients |
| docs/concepts/activities.md | Activity implementation patterns and best practices |
| docs/concepts/README.md | Concepts navigation with suggested reading order |
| docs/advanced/testing.md | Testing strategies for activities and orchestrations |
| docs/advanced/serialization.md | Custom serialization and data converter patterns |
| docs/advanced/middleware.md | Middleware implementation for cross-cutting concerns |
| docs/advanced/entities.md | Entities guidance redirecting to Durable Functions |
| docs/advanced/README.md | Advanced topics overview |
| docs/README.md | Documentation home with quick links and recommendations |
| README.md | Updated to reference new docs folder over wiki |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
This PR adds comprehensive documentation for the Durable Task Framework (DTFx) for .NET.
Documentation was generated primarily using AI so some mistakes may be present. I manually reviewed all the files and did multiple iterations on some of them.
Documentation Structure
Key Highlights