Skip to content

Conversation

@jonathanbossenger
Copy link
Contributor

Adds developer documentation for the Abilities API. This is still a work in progress.

Fixes #5

This is AI generated, so the next step will be a human review
@jonathanbossenger
Copy link
Contributor Author

This documentation was AI-generated, based on the original Features API docs.

My next step will be to review the generated docs manually and update them accordingly.

@vinay070403
Copy link

Thanks for the update! I see that #8 is already in progress. I’ll close my PR to avoid duplication. Happy to help with other issues in the future!

@codecov
Copy link

codecov bot commented Aug 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (trunk@fb95300). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff            @@
##             trunk      #10   +/-   ##
========================================
  Coverage         ?   92.48%           
  Complexity       ?       99           
========================================
  Files            ?        7           
  Lines            ?      519           
  Branches         ?        0           
========================================
  Hits             ?      480           
  Misses           ?       39           
  Partials         ?        0           
Flag Coverage Δ
unit 92.48% <ø> (?)

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.

@gziolo
Copy link
Member

gziolo commented Aug 14, 2025

I updated the branch with GitHub UI to the latest changes from trunk while testing the repo configuration. We are still working on tooling, so there is no need to worry about coding the failing checks with code analysis.

Copy link
Contributor Author

@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.

Initial manual review complete. I just want to test all the code examples.

@jonathanbossenger
Copy link
Contributor Author

Updated all the factual errors. Last step is to test and verify the code examples, but I'm marking this as ready to review so long.

@jonathanbossenger jonathanbossenger marked this pull request as ready for review August 18, 2025 15:33
@jonathanbossenger
Copy link
Contributor Author

  • Updated PR based on review feedback (props @gziolo)
  • Updated Using Abilities examples to rely on WP_Error object return on failure

@gziolo
Copy link
Member

gziolo commented Aug 19, 2025

Would it make sense to land the initial version and tackle the subsequent iterations in follow-up targeted PRs? I approved PR, so with all checks passing, you should be able to merge at any point.

@jonathanbossenger
Copy link
Contributor Author

Would it make sense to land the initial version and tackle the subsequent iterations in follow-up targeted PRs? I approved PR, so with all checks passing, you should be able to merge at any point.

Yup, that was my plan as well. Going to merge here in a bit.

@gziolo gziolo changed the title (WIP) Adding initial developer documentation Adding initial developer documentation Aug 19, 2025
@gziolo gziolo merged commit dde6194 into WordPress:trunk Aug 19, 2025
17 checks passed
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.

Create developer documentation

4 participants