Skip to content

Conversation

justlevine
Copy link
Contributor

@justlevine justlevine commented Aug 28, 2025

What

This PR documents the installation steps for the v0.1.0 release on GH + Composer

How

Cherry picked from #42 and altered to reflect the latest trunk after #35

@justlevine justlevine requested a review from Copilot August 28, 2025 13:52
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 adds comprehensive installation documentation for the Abilities API v0.1.0, providing multiple installation methods for different use cases. The documentation has been updated to reflect the latest state after recent changes and includes practical examples for plugin authors.

  • Replaces basic git clone instructions with multiple installation options
  • Adds dependency management guidance for plugin developers
  • Includes code examples for checking API availability and version requirements

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@justlevine justlevine marked this pull request as ready for review August 28, 2025 13:54
@codecov
Copy link

codecov bot commented Aug 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.43%. Comparing base (f55439d) to head (382aac0).
⚠️ Report is 1 commits behind head on trunk.

Additional details and impacted files
@@            Coverage Diff            @@
##              trunk      #48   +/-   ##
=========================================
  Coverage     88.43%   88.43%           
  Complexity       94       94           
=========================================
  Files             8        8           
  Lines           519      519           
=========================================
  Hits            459      459           
  Misses           60       60           
Flag Coverage Δ
unit 88.43% <ø> (ø)

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 added the [Type] Developer Documentation Improvements or additions to documentation label Aug 28, 2025
Copy link
Contributor

@jonathanbossenger jonathanbossenger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a few suggestions, but nothing that's really blocking a merge. We can always tweak things as we go.


### As a plugin

The easiest way to try and use the Abilities API is to install it as a plugin by downloading the latest release from the [GitHub Releases page](https://github.com/WordPress/abilities-api/releases/latest).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we will have a release available soon, because right now this is not available.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, I believe this is the last PR before we cut v0.1.0

composer require wordpress/abilities-api
```

### Checking availability with code
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One note on these checks, if the code that's doing the checking is inside of a plugin that loads after wp-abilities-api (eg wp-my-plugin) then this might not work. It's on the lower end of the scale of the realm of possibility, but still possible enough to warrant a note about it. I experienced this recently when setting up my workshop examples after recent updates to the mcp-adapter.

@gziolo gziolo merged commit e0423b4 into WordPress:trunk Aug 29, 2025
31 of 32 checks passed
@justlevine justlevine deleted the docs/installation branch August 29, 2025 06:19
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.

3 participants