docs: add TaskEither documentation and update README, changelog, roadmap, index - #25
Merged
Conversation
… and README Co-authored-by: pwlmc <1276139+pwlmc@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation for taskEither and update related files
docs: add TaskEither documentation and update README, changelog, roadmap, index
Feb 25, 2026
pwlmc
marked this pull request as ready for review
February 25, 2026 23:05
pwlmc
added a commit
that referenced
this pull request
Mar 5, 2026
…map, index (#25) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: pwlmc <1276139+pwlmc@users.noreply.github.com>
pwlmc
added a commit
that referenced
this pull request
Mar 5, 2026
…map, index (#25) Co-authored-by: pwlmc <1276139+pwlmc@users.noreply.github.com>
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
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.
Adds full documentation for
TaskEither(the last undocumented effect) and updates the README to describe all effects instead of advertising the library as pre-v1.Changes
docs/task-either.md— Replaces the WIP stub with a complete page: motivation, basic usage (creating, chaining, error handling, running), and a full API reference for all constructors (taskEither,taskLeft,fromEither,fromTask,tryCatch) and methods (map,mapLeft,flatMap,flatten,zip,ap,tap,tapLeft,match,getOrElse,orElse,run,all)docs/index.md— Adds aTaskEithersection to the Getting Started page, consistent with the existingOption,Either,Validation, andTasksectionsREADME.md— Replaces the pre-v1 status block with a concise effects table covering all five typesCHANGELOG.md— Records the documentation additions under[Next]ROADMAP.md— Checks off(doc) TaskEither documentationTaskEither quick example
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.