-
Notifications
You must be signed in to change notification settings - Fork 50
Create reference docs for client-side API #87
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## trunk #87 +/- ##
=========================================
Coverage 86.48% 86.48%
Complexity 148 148
=========================================
Files 18 18
Lines 969 969
Branches 86 85 -1
=========================================
Hits 838 838
Misses 131 131
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
b1f98ea to
818224d
Compare
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Finally got round to testing example code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR creates comprehensive reference documentation for the JavaScript/TypeScript client-side API for WordPress Abilities. The documentation provides developers with detailed function references, examples, and error handling patterns for interacting with the Abilities system from the browser.
Key changes:
- Added complete API reference documentation with function signatures and examples
- Included error handling patterns with specific error codes
- Updated main README to link to the new documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/7.javascript-client.md | New comprehensive API reference documentation covering all client-side functions with examples |
| README.md | Added link to new JavaScript client documentation in the table of contents |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
gziolo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had some minor feedback. Thank you very much for putting it all together.
Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>
Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>
Creates Abilities client-side API reference docs
Closes #86