docs(integrations): add framework README#4722
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR adding a developer-facing README for the Reader Activation Integrations framework, modeled on the data-events README.
Changes:
- New
includes/reader-activation/integrations/README.mddescribing framework purpose, file map, registration flow, push/pull pipelines, settings, data event handlers, ActionScheduler groups, health checks, My Account endpoints, and frontend registration.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Hey @miguelpeixe, good job getting this PR merged! 🎉 Now, the Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label. If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label. Thank you! ❤️ |
kmwilkerson
pushed a commit
that referenced
this pull request
May 14, 2026
kmwilkerson
pushed a commit
that referenced
this pull request
May 15, 2026
3 tasks
kmwilkerson
pushed a commit
that referenced
this pull request
May 15, 2026
kmwilkerson
pushed a commit
that referenced
this pull request
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
All Submissions:
Changes proposed in this Pull Request:
Adds a developer-facing README for the Reader Activation Integrations framework, modeled on
includes/data-events/README.md. Covers the framework purpose, file map, built-inespintegration, the registration flow, required and optional methods on theIntegrationbase class, settings declaration, push/pull pipelines, per-integration data event handlers, ActionScheduler groups, health checks, My Account endpoints, frontend reader registration, and a hooks/storage reference.This is documentation only — no behavioral changes.
Closes NPPD-1082.
Other information: