Repository navigation
docs: align package README with verified contracts - #34
Conversation
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 28 seconds. View limit details
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. Comment |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
1df925b to
2267a21
Compare
2267a21 to
15a17b3
Compare
Changelog✅ Contribution check passed. Head: Base: Contribution: 1 new valid fragment(s). Policy: ordinary.
|
…cs-review-candidate * commit 'd7ee6d191c293a1769931ae5535228a4539808fb': chore: update changelog (#43) feat: adopt independent PER policy and preserve PHPDoc (#40) docs: align package README with verified contracts (#34) # Conflicts: # docs/architecture.md # docs/policy.md # docs/resolved-preset.md
Align the README with the actual package/CLI/configuration contract and the now verified published0.1.0 installation. Add source-backed badges, features, API summary, layout, versioning, FAQ and contribution guidance. Preserve check/fix/no-write/trust/cache limitations; no coverage site, metrics or stable-product claim is invented.
Closes #30.
This PR now targets main independently and contains only README.md plus its explicit PR34 patch fragment. The former skills33 dependency was unnecessary and has been removed through official unstack and a guarded ref update. No skills installation, image generation or Sphinx migration is inherited. The separate33 banner addition must be preserved when the two README edits are reconciled; after29 migrates docs, update current source links to the RST destinations rather than restoring deleted Markdown.
Verified baseline: published v0.1.0 and Composer source/distd28de6cd19733b9f34c781644c4fda899c6fe3b8. A fresh Composer consumer installed21runtime packages, actual installed binary check returned2 without source/lock writes, explicit fix0 then check0/fix0 was stable with lock unchanged. Read-only authoring skill reference is DevTools package-readme at84e154046e07cafa6ac09a9e12434b1ff5dcb5e0; it was never imported. Current native Changelog contribution check and local links/whitespace pass. Independent review approved the main-only candidate and real installation examples.
Current HEAD15a17b3e9cb35a1fc3bbbf5a3fa8e70875315b49, based on published main d28de6c. Previous2267a216 retained in codex/checkpoint-pr34-20261026 and a verified full-history local bundle; ref update was atomic with exact expected-OID leases. Current-head hosted CI and both external reviews still govern readiness. Publication remains the user's action.