docs: add sdk scope coverage matrix

[soulevilx]

Add SDK scope coverage matrix documentation.

Summary by CodeRabbit

• Documentation
  • Added a comprehensive WordPress REST API coverage matrix comparing SDK services to the official WordPress reference.
  • Clarified SDK core scope boundaries throughout documentation to strengthen contributor and user guidance.
  • Reorganized maintenance documentation structure for improved clarity and discoverability.
  • Enhanced helper dependency guidance for long-term maintenance planning.

[qodo-code-review]

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

[coderabbitai]

Warning

Rate limit exceeded

@soulevilx has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 50 minutes and 2 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4e136162-3e7d-45bf-8f57-9e3c7578277b

📥 Commits

Reviewing files that changed from the base of the PR and between bf0c4bc and 80eda44.

📒 Files selected for processing (2)

• README.md
• docs/05-maintenance/01-risks-and-gaps.md

📝 Walkthrough

Walkthrough

This PR consolidates and clarifies SDK scope boundaries across documentation. It defines what SDK core covers (native WordPress REST API client, DTOs, auth, pagination, discovery, error handling, generic REST helpers) versus what it excludes (opinionated content templates, orchestration workflows, plugin/theme-specific implementation logic). A new coverage matrix documents endpoint support against the official WordPress REST API reference. Maintenance documentation is restructured with numbered files and updated scope/gap specificity.

Changes

SDK Scope Boundary and Coverage Documentation

Layer / File(s)	Summary
Scope Boundary Definition in Public Documentation README.md, CONTRIBUTING.md, docs/02-user-guide/01-services-and-queries.md, docs/04-development/ai-contributor-guide.md	README and CONTRIBUTING establish explicit SDK core scope boundaries. User guide and AI contributor guide clarify scope limits and add rules for helpers tightly coupled to plugin/theme contracts to be marked as extraction/deprecation candidates rather than expanded into core.
Detailed Maintenance Scope and Coverage Documentation docs/05-maintenance/01-risks-and-gaps.md, docs/05-maintenance/02-wordpress-rest-api-coverage-matrix.md, docs/05-maintenance/risks-gaps-and-roadmap.md	Risks-and-gaps document replaces vague gaps framing with explicit scope boundary section. New WordPress REST API coverage matrix tables typed core endpoints against official reference. Adds specificity to 1.2.0 coverage gaps (block pattern reference groups, navigation revisions, partial ApplicationPasswordsService). Documents helper extraction watchlist and operational validation requirements.
Documentation Index and Navigation Updates docs/05-maintenance/README.md, docs/README.md, CHANGELOG.md, docs/05-maintenance/docs-changelog.md	Maintenance documentation structure reorganized with three numbered entries pointing to risks/scope, coverage matrix, and compatibility summary. Main docs README updated. Changelog entries document new coverage matrix alignment and scope boundary clarification across all guidance documents.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Documentation springs to life,
Boundaries drawn without the strife,
What the SDK tends, what it won't—
Clear as clover, firm and won't.
REST API matrices now shine,
Scope's defined by careful design! 🌿

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add sdk scope coverage matrix' accurately describes the main change—adding a new documentation page with a coverage matrix comparing the SDK against the WordPress REST API reference.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/sdk-scope-coverage-matrix

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Adds and wires in a maintenance-focused WordPress REST API coverage matrix, while clarifying (and repeating consistently across entry points) what is and isn’t considered “SDK core” for this repository.

Changes:

• Added a new endpoint-by-endpoint WordPress REST API coverage matrix under maintenance docs.
• Reorganized maintenance documentation navigation to prefer numbered docs, keeping the prior “risks/gaps/roadmap” page as a compatibility summary.
• Strengthened SDK scope-boundary and helper-extraction guidance across README, user docs, contributing docs, and AI contributor guidance.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
README.md	Links to the new coverage matrix and adds an explicit “SDK core boundary” section plus helper extraction guidance.
docs/README.md	Updates the Maintenance section links to point to the new numbered maintenance docs.
docs/05-maintenance/risks-gaps-and-roadmap.md	Reframes as a compatibility summary and links to the numbered maintenance docs.
docs/05-maintenance/README.md	Updates maintenance index to the new numbered docs and keeps the compatibility summary link.
docs/05-maintenance/docs-changelog.md	Records the new coverage matrix and scope-boundary documentation updates.
docs/05-maintenance/02-wordpress-rest-api-coverage-matrix.md	New: comprehensive REST API coverage matrix and documented gaps/partials.
docs/05-maintenance/01-risks-and-gaps.md	Expands and restructures maintenance notes into scope boundary, confirmed gaps, and helper watchlist.
docs/04-development/ai-contributor-guide.md	Adds explicit SDK core scope boundary and guidance on handling plugin/theme-coupled helpers.
docs/02-user-guide/01-services-and-queries.md	Adds scope boundary statement and guidance on extraction candidates for coupled helpers.
CONTRIBUTING.md	Adds scope boundary rules to contributor coding standards.
CHANGELOG.md	Notes documentation additions under Unreleased.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.