Skip to content

Add comprehensive documentation comments to precompiled samples#3306

Draft
Copilot wants to merge 3 commits into
devfrom
copilot/update-documentation-samples
Draft

Add comprehensive documentation comments to precompiled samples#3306
Copilot wants to merge 3 commits into
devfrom
copilot/update-documentation-samples

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 5, 2026

Summary

What changed?

  • Added header comments to all precompiled sample files with pattern overview, documentation links, run instructions, and required app settings
  • Added inline comments explaining key code logic
  • Created samples/precompiled/README.md with pattern mapping table, setup instructions, and curl examples

Why is this change needed?

Developers had difficulty navigating samples to understand patterns and run them. Monitor.cs had good documentation; other samples did not.

Issues / work items


Project checklist

  • Documentation changes are not required
  • Release notes are not required for the next release
  • Backport is not required
  • All required tests have been added/updated (unit tests, E2E tests)
  • No extra work is required to be leveraged by OutOfProc SDKs
  • No change to the version of the WebJobs.Extensions.DurableTask package
  • No EventIds were added to EventSource logs
  • This change should be added to the v2.x branch
  • Breaking change?

AI-assisted code disclosure (required)

Was an AI tool used? (select one)

  • No
  • Yes, AI helped write parts of this PR (e.g., GitHub Copilot)
  • Yes, an AI agent generated most of this PR

If AI was used:

  • Tool(s): GitHub Copilot coding agent
  • AI-assisted areas/files: All sample .cs files (comment additions only), README.md
  • What you changed after AI output: Code review feedback addressed (updated .NET SDK and Core Tools version requirements)

AI verification (required if AI was used):

  • I understand the code and can explain it
  • I verified referenced APIs/types exist and are correct
  • I reviewed edge cases/failure paths (timeouts, retries, cancellation, exceptions)
  • I reviewed concurrency/async behavior
  • I checked for unintended breaking or behavior changes

Testing

Automated tests

  • Result: Passed - dotnet build VSSample.csproj succeeds with 0 warnings, 0 errors

Manual validation (only if runtime/behavior changed)

  • N/A - Documentation-only changes

Notes for reviewers

  • No code logic changed; all modifications are comments and documentation
  • Sample file names retained (renaming would break references); pattern mapping provided in README table instead
  • Issue item "add links after each pattern in Overview article" requires changes to external Microsoft Docs, not this repo

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • azfunc.pkgs.visualstudio.com
    • Triggering command: /opt/hostedtoolcache/CodeQL/2.23.8/x64/codeql/csharp/tools/linux64/Semmle.Autobuild.CSharp /opt/hostedtoolcache/CodeQL/2.23.8/x64/codeql/csharp/tools/linux64/Semmle.Autobuild.CSharp (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>More intuitive documentation and samples</issue_title>
<issue_description>Durable Functions' documentation is extensive, but navigating it can be difficult for developers who just want to get to the examples and run them. This issue tracks a proposed series of changes to ease the learning curve:

  • After each pattern in the Overview article, add link to its corresponding sample.
  • Add comments to each sample similar to what exists for the Monitor sample, including:
  • Brief (1-2 sentence) overview of pattern demonstrated
  • Required setup (app settings, account registrations)
  • How to run
  • Inline comments explaining logic / why we do this, not that
  • Rename sample files to match the patterns they implement
    </issue_description>

<agent_instructions>check if this issue still exists, if so fix it</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 5, 2026 22:45
Co-authored-by: YunchuWang <12449837+YunchuWang@users.noreply.github.com>
Co-authored-by: YunchuWang <12449837+YunchuWang@users.noreply.github.com>
Copilot AI changed the title [WIP] Improve documentation and samples for Durable Functions Add comprehensive documentation comments to precompiled samples Jan 5, 2026
Copilot AI requested a review from YunchuWang January 5, 2026 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

More intuitive documentation and samples activityTrigger, orchestrationTrigger, and orchestrationClient bindings not registered [javascript]

2 participants