Skip to content

Documentation review fixes - #100

Merged
rasuvaeff merged 1 commit into
masterfrom
docs/review-fixes
Sep 4, 2026
Merged

Documentation review fixes#100
rasuvaeff merged 1 commit into
masterfrom
docs/review-fixes

Conversation

@rasuvaeff

Copy link
Copy Markdown
Owner

Fixes every finding of the 2026-09-04 documentation review (3 critical, 4 warnings, 3 notes) — docs only, no runtime code changed.

Critical

  • llms.txt no longer claims bypassFinals() and the runner adapters are «being built next» — both shipped long ago and are documented earlier in the same file.
  • The Prophecy migration table no longer teaches a non-existent expect(…)->never(); the supported form is expect(…)->times(0). Fixed in the source page (docs/src/guide/migrating-from-phpunit.md) and MIGRATION.md regenerated via render-migration.mjs.

Warnings

  • Performance table: 5.38׳ (a damaged character) → 5.38³ — the footnote marker now points at the footnote, in both READMEs.
  • llms.txt now carries the : static loose-default rule from 0.7.0.
  • AGENTS.md's dead link to the retired _plans/UNDERSTUDY-DOCS-SITE-PLAN.md replaced with where the decisions live.
  • examples/README.md now documents case-studies/ and its gate (make docs-cookbook / docs CI) — the scripts were gated all along, just undiscoverable.

Notes

  • llms.txt and AGENTS.md list all four free functions (when/expect/expectSequence/verify).
  • idle() comments everywhere now say what it does: covers every context of the test (README EN/RU, llms.txt, guide pages).
  • make build comment lists everything the script runs, including integration and examples.

Verification: bin/package-audit PASS; docs integrity, anchor and migration checks PASS; composer build green (part of the family-wide bin/dev build 'understudy*' run — 5/5 OK).

@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: bcdc96a6-53cb-40e0-99f0-85e0ae10f8b7

Warning

Your free Security trial is over. An organization admin can upgrade to Advanced for continuous pull request security review or dismiss this notice.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@rasuvaeff
rasuvaeff merged commit 1977a58 into master Sep 4, 2026
20 checks passed
@rasuvaeff
rasuvaeff deleted the docs/review-fixes branch September 4, 2026 09:53
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