Skip to content

docs: clarify Abilities API is core in 6.9+ (fixes #150)#223

Open
mathetos wants to merge 1 commit into
WordPress:trunkfrom
mathetos:fix/150-abilities-api-core-docs
Open

docs: clarify Abilities API is core in 6.9+ (fixes #150)#223
mathetos wants to merge 1 commit into
WordPress:trunkfrom
mathetos:fix/150-abilities-api-core-docs

Conversation

@mathetos

@mathetos mathetos commented Jun 24, 2026

Copy link
Copy Markdown

Summary

Some docs still read like you need a separate Abilities API install. README.md was mostly updated in #165 and #204, but readme.txt and the getting-started guides were still Composer-first and pretty quiet about core.

This PR lines those up: says plainly that Abilities API ships with WordPress 6.9+, matches install docs to README (plugin first, Composer for plugin devs), and tightens the admin notice when core is too old.

Closes #150

What changed

  • README.md: one line in Dependencies
  • readme.txt: plugin-first install wording
  • docs/getting-started/README.md and installation.md: same story, flipped order
  • common-issues.md + Plugin.php: clearer "you need WP 6.9+" messaging

Test plan

  • Read-through for stale abilities-api / composer require references
  • Maintainer eyeball on install doc ordering

Sync readme.txt and getting-started docs with README.md, and make
dependency messaging explicit that no separate abilities-api plugin is needed.
@github-actions

github-actions Bot commented Jun 24, 2026

Copy link
Copy Markdown

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @zoopster.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Unlinked contributors: zoopster.

Co-authored-by: mathetos <webdevmattcrom@git.wordpress.org>
Co-authored-by: justlevine <justlevine@git.wordpress.org>

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

@codecov

codecov Bot commented Jun 24, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 87.86%. Comparing base (90252e7) to head (27e46a0).

Files with missing lines Patch % Lines
includes/Plugin.php 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff            @@
##              trunk     #223   +/-   ##
=========================================
  Coverage     87.86%   87.86%           
  Complexity     1245     1245           
=========================================
  Files            53       53           
  Lines          4037     4037           
=========================================
  Hits           3547     3547           
  Misses          490      490           
Flag Coverage Δ
unit 87.86% <0.00%> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

@justlevine justlevine added the [Type] Developer Documentation Improvements or additions to documentation label Jun 24, 2026
@justlevine justlevine self-requested a review June 24, 2026 21:24
@mathetos

Copy link
Copy Markdown
Author

Quick note on the failing codecov/patch check: this PR is mostly docs, but it also tweaks one admin-notice string in includes/Plugin.php. Patch coverage wants a test to execute that line, and we do not have one for the missing-Abilities-API path. Everything else is green (full PHPUnit matrix, PHPCS, PHPStan, Plugin Check, codecov/project).

I would treat the patch failure as noise here rather than block merge. Happy to drop the Plugin.php line in a follow-up if you prefer docs-only PRs for codecov hygiene, or add a small test if you want patch green instead.

@justlevine

Copy link
Copy Markdown
Contributor

Happy to drop the Plugin.php line in a follow-up if you prefer docs-only PRs for codecov hygiene

Less about the hygiene (changelog here isnt automated yet), and more that we can approve/merge that string change in Plugin.php in a few minutes. There's a lot of slop in the existing docs that requires a real sit-down to confirm this closes #150 . Up to you.

@mathetos

mathetos commented Jun 24, 2026 via email

Copy link
Copy Markdown
Author

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.

README references to archived abilities api project

2 participants