Skip to content

Conversation

jonathanbossenger
Copy link
Contributor

@jonathanbossenger jonathanbossenger commented Sep 26, 2025

Creates Abilities client-side API reference docs

  • Includes link to package readme for installing and usage instructions
  • Lists all API functions with example code

Closes #86

Copy link

codecov bot commented Sep 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.69%. Comparing base (cbe8a59) to head (54849b9).

Additional details and impacted files
@@            Coverage Diff            @@
##              trunk      #87   +/-   ##
=========================================
  Coverage     85.69%   85.69%           
  Complexity      103      103           
=========================================
  Files            16       16           
  Lines           776      776           
  Branches         86       85    -1     
=========================================
  Hits            665      665           
  Misses          111      111           
Flag Coverage Δ
javascript 92.66% <ø> (ø)
unit 82.97% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@gziolo gziolo requested a review from emdashcodes September 26, 2025 16:48
@gziolo gziolo added the [Type] Developer Documentation Improvements or additions to documentation label Sep 26, 2025
@jonathanbossenger jonathanbossenger marked this pull request as ready for review September 30, 2025 09:31
Copy link

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: jonathanbossenger <psykro@git.wordpress.org>
Co-authored-by: gziolo <gziolo@git.wordpress.org>
Co-authored-by: emdashcodes <emdashcodes@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@jonathanbossenger
Copy link
Contributor Author

Finally got round to testing example code
Added link back to package readme

Copy link
Contributor

@Copilot Copilot AI left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: client-side reference for Abilities API
2 participants