Skip to content

docs: streamline README — reduce size by 53%#122

Merged
andrey-helldar merged 3 commits intomainfrom
copilot/improve-readme-content
Apr 11, 2026
Merged

docs: streamline README — reduce size by 53%#122
andrey-helldar merged 3 commits intomainfrom
copilot/improve-readme-content

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 11, 2026

README had significant redundancy: 4 calling styles × 2 entry points (function/class) = 8 near-identical code blocks, 4 separate callback sections with duplicated patterns, 5 toConsole output variants, and verbose DTO dumps. Trimmed without losing any documentation coverage.

Changes (780 → 345 lines, 21.7 KB → 12 KB):

  • Installation: Removed manual composer.json method — composer require is sufficient
  • Usage: Collapsed "How To Use" + "As a function" + "As a class" (8 code blocks) into one section with 2 blocks showing the two key patterns (named args vs associative array); removed redundant "Quick Start" heading
  • Iterations: Consolidated 3 code blocks into 1; dropped negative-value edge case docs
  • Deviations: Removed pseudocode explanation blocks and iterations() call from the example; the example + output speak for themselves
  • Callbacks: Merged 4 subsections (before/beforeEach/after/afterEach, 8 code blocks) into 1 section with a single chained example
  • Results → toConsole: 5 options → 1 code block + 2 output examples (standard + deviations); fixed deviation table header to use named keys
  • Results → toData: Kept the full DTO dump block with deviation example to show the complete object structure
  • Results → toAssert: Merged two near-duplicate examples into one, noting from/till are independently optional

Copilot AI and others added 2 commits April 11, 2026 16:21
…tion coverage

Agent-Logs-Url: https://github.com/TheDragonCode/benchmark/sessions/c741979a-f7af-4220-88c5-ed7907efab32

Co-authored-by: andrey-helldar <10347617+andrey-helldar@users.noreply.github.com>
Agent-Logs-Url: https://github.com/TheDragonCode/benchmark/sessions/c741979a-f7af-4220-88c5-ed7907efab32

Co-authored-by: andrey-helldar <10347617+andrey-helldar@users.noreply.github.com>
…ations() from deviations example, fix table header, restore toData DTO block

Agent-Logs-Url: https://github.com/TheDragonCode/benchmark/sessions/07c31b41-e79f-4d89-ba9a-87c98253fe31

Co-authored-by: andrey-helldar <10347617+andrey-helldar@users.noreply.github.com>
Copilot AI requested a review from andrey-helldar April 11, 2026 17:05
@andrey-helldar andrey-helldar marked this pull request as ready for review April 11, 2026 17:06
@andrey-helldar andrey-helldar merged commit 2306a22 into main Apr 11, 2026
@andrey-helldar andrey-helldar deleted the copilot/improve-readme-content branch April 11, 2026 17:06
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.

2 participants