mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Chris
904a5b843e
* Python: .NET Samples - Restructure and Improve Samples (Feature Branch) (#4091) * Moved by agent (#4094) * Fix readme links * .NET Samples - Create `04-hosting` learning path step (#4098) * Agent move * Agent reorderd * Remove A2A section from README Removed A2A section from the Getting Started README. * Agent fixed links * Fix broken sample links in durable-agents README (#4101) * Initial plan * Fix broken internal links in documentation Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> * Revert template link changes; keep only durable-agents README fix Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> * .NET Samples - Create `03-workflows` learning path step (#4102) * Fix solution project path * Python: Fix broken markdown links to repo resources (outside /docs) (#4105) * Initial plan * Fix broken markdown links to repo resources Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> * Update README to rename .NET Workflows Samples section --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> * .NET Samples - Create `02-agents` learning path step (#4107) * .NET: Fix broken relative link in GroupChatToolApproval README (#4108) * Initial plan * Fix broken link in GroupChatToolApproval README Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> * Update labeler configuration for workflow samples * .NET - Reorder Agents samples to start from Step01 instead of Step04 (#4110) * Fix solution * Resolve new sample paths * Move new AgentSkills and AgentWithMemory_Step04 samples * Fix link * Fix readme path * fix: update stale dotnet/samples/Durable path reference in AGENTS.md Co-authored-by: crickman <66376200+crickman@users.noreply.github.com> * Moved new sample * Update solution * Resolve merge (new sample) * Sync to new sample - FoundryAgents_Step21_BingCustomSearch * Updated README * .NET Samples - Configuration Naming Update (#4149) * .NET: Restore AzureFunctions index parity with ConsoleApps under DurableAgents samples (#4221) * Clean-up `05_host_your_agent` * Config setting consistency * Refine samples * AGENTS.md * Move new samples * Re-order samples * Move new project and fixup solution * Fixup model config * Fix up new UT project --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
3.0 KiB
3.0 KiB
AGENTS.md
Instructions for AI coding agents working on durable agents documentation.
Scope
This directory contains feature documentation for the durable agents integration. The source code and samples live elsewhere:
- .NET implementation:
dotnet/src/Microsoft.Agents.AI.DurableTask/anddotnet/src/Microsoft.Agents.AI.Hosting.AzureFunctions/ - Python implementation:
python/packages/durabletask/andpython/packages/azurefunctions/(packageagent-framework-azurefunctions) - .NET samples:
dotnet/samples/04-hosting/DurableAgents/ - Python samples:
python/samples/04-hosting/durabletask/ - Official docs (Microsoft Learn): https://learn.microsoft.com/agent-framework/integrations/azure-functions
Document structure
| File | Purpose |
|---|---|
README.md |
Main technical overview: architecture, hosting models, orchestration patterns, and links to samples. |
durable-agents-ttl.md |
Deep-dive on session Time-To-Live (TTL) configuration and behavior. |
Add new sibling documents when a topic is too detailed for the README (e.g., a new feature like reliable streaming or MCP tool exposure). Keep the README focused on orientation and link out to siblings for depth.
Writing guidelines
- Audience: Developers already familiar with the Microsoft Agent Framework who want to understand what durability adds and how to use it.
- Host-agnostic first: Durable agents work in console apps, Azure Functions, and any Durable Task–compatible host. Show host-agnostic patterns (plain orchestration functions,
IServiceCollectionregistration) before Azure Functions–specific patterns. Avoid giving the impression that Azure Functions is the only hosting option. - Both languages: Always include C# and Python examples side by side. Keep them equivalent in functionality.
- Callout syntax: Use GitHub-flavored callouts (
> [!NOTE],> [!IMPORTANT],> [!WARNING]) rather than bold-text callouts (> **Note:** ...). - Line length: Do not wrap long lines. Rely on text viewers / renderers for line wrapping.
- Tables: Use spaces around pipes in separator rows (
| --- |not|---|). - Code snippets: Keep them minimal and self-contained. Omit boilerplate (using statements, environment variable reads) unless the snippet is specifically about setup.
- Cross-references: Link to Microsoft Learn for conceptual background (Durable Entities, Durable Task Scheduler, Azure Functions). Link to sibling docs within this directory for feature deep-dives.
Linting
Run markdownlint on all documents before committing, with line-length checks disabled:
markdownlint docs/features/durable-agents/ --disable MD013
When to update these docs
- A new durable agent feature is added (e.g., a new orchestration pattern, hosting model, or configuration option).
- The public API surface changes in a way that affects how developers use durable agents.
- New sample directories are added — update the sample links in README.md.
- The official Microsoft Learn documentation is restructured — update external links.