Skip to content

.NET: [Bug]: outdated and not relevant declarative workflow documentation #7977

Description

@dsslight

Description

The Declarative workflow documentation does not reflect the current behavior, which is misleading and confusing for developers.
For example:

  1. compare the documented Question and SendActivity descriptions with the usage samples in the repository.
  2. SendMessage is not documented at all.
  3. InvokeFunctionTool mentioned as supposed to provide result to Local.* env variable, but if you use it - declarative.dll throws error that variable not defined/found. Answer here - Topic.* variable needs to be used and value available over Local.* namespace.

related references with more up to date info found

https://github.com/microsoft/agent-framework/blob/main/dotnet/samples/03-workflows/Declarative/ConfirmInput/ConfirmInput.yaml
documentation defined contract for Question action simply doesn't work and contains bunch of errors. Refer dev samples

additional samples
https://github.com/microsoft/agent-framework/blob/main/dotnet/samples/03-workflows/Declarative/FileInput/FileInput.yaml
https://github.com/microsoft/agent-framework/blob/main/dotnet/samples/03-workflows/Declarative/InvokeFunctionTool/InvokeFunctionTool.yaml
https://github.com/microsoft/agent-framework/blob/main/dotnet/samples/03-workflows/Declarative/AotCheckpointing/AotCheckpointing.yaml

Code Sample

Error Messages / Stack Traces

Package Versions

Microsoft.Agents.AI.Workflows.Declarative

.NET Version

.NET 10.0.300

Additional Context

documentation related issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    .NETUsage: [Issues, PRs], Target: .NetreproducedUsage: [Issues], Target: all issues that can be reproduced by the triage workflowtriageUsage: [Issues], Target: All issues that still need to be triaged

    Type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions