Skip to content

docs: complete the README and contributing guide - #41

Merged
Frognar merged 1 commit into
mainfrom
docs/complete-readme
Nov 14, 2026
Merged

Frognar merged 1 commit into
mainfrom
docs/complete-readme

Conversation

@Frognar

@Frognar Frognar commented Nov 14, 2026

Copy link
Copy Markdown
Owner

What

Card 7.3 of milestone M7 (1.0.0).

  • README intro: a form example with Validated.Combine (the point of the library, every error at once), beta status (the API is complete), and feature bullets covering accumulation, unions, your own error type, no accessors, the full API and zero allocation / AOT / no dependencies.
  • README "Migrating from 0.5": a table from the 0.5 API (Validated<T> with a fixed ValidationError(PropertyName, Error), Validation.Succeed/Failed, IsValid, Match(errors, value), curried Apply up to 16, .NET Standard 2.0) to 1.0. It links the archive/0.5 branch.
  • The Usage sections were written card by card since M1 and already match the API. CONTRIBUTING already covers the three releases, the Release-As footer and the Stryker rules; 8.1 updates it for 1.0.0.

Closes #21

Checklist

  • Tests cover the change (properties first, examples only where a property does not fit) (n/a: docs)
  • dotnet test --solution dotValid.slnx is green locally (n/a)
  • Public API changes have XML docs (n/a)

🤖 Generated with Claude Code

https://claude.ai/code/session_012weRUz3QcTAaQw32ZmQkoK

A form example with Combine up front, beta status, the full feature list,
and a migration table from 0.5.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012weRUz3QcTAaQw32ZmQkoK
@Frognar
Frognar merged commit 68fa351 into main Nov 14, 2026
5 checks passed
@Frognar
Frognar deleted the docs/complete-readme branch November 14, 2026 12:00
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.

docs: complete the README and contributing guide

1 participant