Skip to content

Rebuild TaskFlow documentation - #23

Merged
dombrovsky merged 8 commits into
mainfrom
agent/taskflow-documentation
Aug 16, 2026
Merged

dombrovsky merged 8 commits into
mainfrom
agent/taskflow-documentation

Conversation

@dombrovsky

@dombrovsky dombrovsky commented Aug 16, 2026

Copy link
Copy Markdown
Owner

What changed

  • add a goal-oriented GitHub Pages documentation tree under docs/
  • rewrite the repository and package-specific READMEs around TaskFlow's owned FIFO execution-lane positioning
  • document lifecycle, cancellation, timeout, throttling, execution models, extension ordering, DI, compatibility, and troubleshooting
  • add package-specific NuGet descriptions and discovery tags
  • add a lightweight GitHub Pages workflow that builds the Jekyll site on pull requests and deploys it automatically from main

Why

The previous root README made broad performance, concurrency, and disposal claims and did not provide comprehensive guidance for TaskFlow's production usage patterns or edge-case semantics. Issue #19 also requires the long-form documentation to have stable Pages URLs and automatic publication.

Impact

This change updates documentation, package metadata, and Pages automation only. It does not change runtime APIs or behavior.

Validation

  • Release build succeeded with zero warnings and errors
  • 464 test executions passed across .NET 8 and .NET 10
  • all 44 C# snippets extracted from 19 Markdown files were compiled during one-time release-remediation validation
  • local links, anchors, front matter, canonical permalinks, and packaged NuGet metadata were checked during one-time validation
  • the Pages workflow builds the complete Jekyll site on pull requests before deployment from main

Closes #19

@dombrovsky
dombrovsky marked this pull request as ready for review August 16, 2026 17:59
@dombrovsky
dombrovsky merged commit 320d282 into main Aug 16, 2026
3 checks passed
@dombrovsky
dombrovsky deleted the agent/taskflow-documentation branch August 16, 2026 21:55
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.

Add a GitHub Pages documentation site

1 participant