Skip to content

docs(integrations): add framework README#4722

Merged
miguelpeixe merged 1 commit into
trunkfrom
docs/nppd-1082-integrations-readme
May 14, 2026
Merged

docs(integrations): add framework README#4722
miguelpeixe merged 1 commit into
trunkfrom
docs/nppd-1082-integrations-readme

Conversation

@miguelpeixe
Copy link
Copy Markdown
Member

@miguelpeixe miguelpeixe commented May 13, 2026

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-in esp integration, the registration flow, required and optional methods on the Integration base 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:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md describing 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.

@miguelpeixe miguelpeixe marked this pull request as ready for review May 14, 2026 17:24
@miguelpeixe miguelpeixe requested a review from a team as a code owner May 14, 2026 17:24
@miguelpeixe miguelpeixe merged commit d1009c0 into trunk May 14, 2026
11 checks passed
@miguelpeixe miguelpeixe deleted the docs/nppd-1082-integrations-readme branch May 14, 2026 17:24
@github-actions
Copy link
Copy Markdown

Hey @miguelpeixe, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

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! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants