Skip to content

docs: update API reference, READMEs, skills, and coverage script - #25

Merged
senrecep merged 2 commits into
mainfrom
docs/update-documentation
May 27, 2026
Merged

docs: update API reference, READMEs, skills, and coverage script#25
senrecep merged 2 commits into
mainfrom
docs/update-documentation

Conversation

@senrecep

Copy link
Copy Markdown
Owner

Summary

  • API Reference (docs/API_REFERENCE.md): Added missing sections for collection batch APIs (Result, Maybe, Any) and railway validation bindings (ValidateWith/ValidateWithAsync)
  • Module READMEs: Updated Results, Maybe, Any, Validation READMEs with new collection extension and railway integration sections
  • Skills consolidation: Moved csharpessentials-validation skill to .well-known/agent-skills/, updated index.json to 19 packages, removed duplicate .agents/skills/ directory
  • AGENTS.md: Updated package count (14+ → 19), added git hooks setup line
  • CLAUDE.md: Replaced duplicated content with a thin reference pointing to AGENTS.md
  • scripts/analyze_example_coverage.py: Removed hardcoded /Users/recepsen/... path (now uses Path(__file__).parent.parent), added CSharpEssentials.Validation to LIB_EXAMPLE_MAP, translated all Turkish comments/strings to English

Test plan

  • Verify scripts/analyze_example_coverage.py runs from any machine: python3 scripts/analyze_example_coverage.py
  • Verify .well-known/agent-skills/index.json has 19 entries
  • Verify .agents/skills/ directory is gone
  • Review API_REFERENCE.md sections for Result/Maybe/Any collection extensions and Validation railway bindings
  • Review CLAUDE.md is now a thin reference (no duplicate content)

🤖 Generated with Claude Code

senrecep and others added 2 commits May 27, 2026 20:31
… collection batch, and Any traverse

- SelectAsync Task failure path (ResultT.Select.cs:99)
- AnyCollectionExtensions T3 Traverse + T4 null selector guard
- ResultCollectionExtensions Traverse failure, IResult Partition, FirstFailureOrSuccesses all-success paths

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- docs/API_REFERENCE.md: add collection extensions (Result, Maybe, Any)
  and railway validation bindings (ValidateWith/ValidateWithAsync) sections
- CSharpEssentials.Results/Readme.MD: add collection extensions section
- CSharpEssentials.Maybe/Readme.MD: add collection extensions section
- CSharpEssentials.Any/Readme.MD: add collection extensions section
- CSharpEssentials.Validation/Readme.MD: add railway integration section
- .well-known/agent-skills/: add csharpessentials-validation skill,
  update index.json to 19 packages, remove duplicate .agents/skills/
- AGENTS.md: update to 19 packages, add git hooks setup line
- CLAUDE.md: replace with thin reference pointing to AGENTS.md
- scripts/analyze_example_coverage.py: remove hardcoded project path,
  add Validation to LIB_EXAMPLE_MAP, translate all comments to English

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov

codecov Bot commented May 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@senrecep
senrecep merged commit b8c30af into main May 27, 2026
5 checks passed
@senrecep
senrecep deleted the docs/update-documentation branch May 27, 2026 17:52
senrecep added a commit that referenced this pull request May 27, 2026
* test(results,collections,any): add missing coverage for async select, collection batch, and Any traverse

- SelectAsync Task failure path (ResultT.Select.cs:99)
- AnyCollectionExtensions T3 Traverse + T4 null selector guard
- ResultCollectionExtensions Traverse failure, IResult Partition, FirstFailureOrSuccesses all-success paths

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: update API reference, READMEs, skills, and script for new APIs

- docs/API_REFERENCE.md: add collection extensions (Result, Maybe, Any)
  and railway validation bindings (ValidateWith/ValidateWithAsync) sections
- CSharpEssentials.Results/Readme.MD: add collection extensions section
- CSharpEssentials.Maybe/Readme.MD: add collection extensions section
- CSharpEssentials.Any/Readme.MD: add collection extensions section
- CSharpEssentials.Validation/Readme.MD: add railway integration section
- .well-known/agent-skills/: add csharpessentials-validation skill,
  update index.json to 19 packages, remove duplicate .agents/skills/
- AGENTS.md: update to 19 packages, add git hooks setup line
- CLAUDE.md: replace with thin reference pointing to AGENTS.md
- scripts/analyze_example_coverage.py: remove hardcoded project path,
  add Validation to LIB_EXAMPLE_MAP, translate all comments to English

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant