docs(ack-id): fix README typo, link, and type guard exports - #188
docs(ack-id): fix README typo, link, and type guard exports#188crazywriter1 wants to merge 2 commits into
Conversation
venables
left a comment
There was a problem hiding this comment.
Thank you @crazywriter1 !
|
@crazywriter1 mind running the formatter on this again? |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review. WalkthroughThe Changesack-id README updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to This documentation-only change corrects the handshake example, demo link, and exported type-guard documentation without changing runtime behavior or the public implementation; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
|
Thanks for the review sir.. Done. Ran the formatter on the README. CI should pass now. @venables |
Problem
The ack-id README had three copy-paste issues:
t const response, which is invalid TypeScript.../docs/demos/demo-identity-a2a.mdx, which resolves topackages/docs/...and 404s from the package README. The file lives atdocs/demos/demo-identity-a2a.mdx.isControllerClaim, which is not exported from the package. The public type guard isisControllerCredential.Fix
Correct the typo, fix the relative link to
../../docs/demos/demo-identity-a2a.mdx, and document only the exportedisControllerCredentialAPI.No changeset: documentation-only README fix with no runtime or API change.
AI usage
Per AI_POLICY.md, Cursor found these during a docs scan of main. I read the diff before opening this.
Summary by CodeRabbit
isControllerClaimreference.