docs: add installation steps for release#48
Conversation
There was a problem hiding this comment.
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.
Codecov Report✅ All modified and coverable lines are covered by tests. 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
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:
|
gziolo
added
the
[Type] Developer Documentation
jonathanbossenger
left a comment
jonathanbossenger
left a comment
There was a problem hiding this comment.
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). |
There was a problem hiding this comment.
I assume we will have a release available soon, because right now this is not available.
There was a problem hiding this comment.
Yup, I believe this is the last PR before we cut v0.1.0
| composer require wordpress/abilities-api | ||
| ``` | ||
|
|
||
| ### Checking availability with code |
There was a problem hiding this comment.
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.
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
trunkafter #35