Skip to content

Development Notes

Jump to bottom
Shane Rounce edited this page May 12, 2026 · 2 revisions

Development notes

This page is for practical maintenance and contributor context.

Repository shape

  • adaptive-customer-engagement.php bootstraps the plugin
  • includes/ holds the PHP classes
  • assets/src/admin/ holds the source admin app
  • assets/src/frontend/ holds the frontend tracker
  • assets/build/ holds generated build assets

Build commands

From the plugin directory:

npm install
npm run build

Validation expectations

When I touch PHP, I want the changed files checked with:

php -l path/to/file.php

When I touch the admin or frontend JavaScript, I want the assets rebuilt so the working copy stays in step with the source.

Multisite and plugin-interaction notes

The current build now has a few extra guardrails that matter when this plugin sits beside other AceMedia plugins:

  • plugin-owned bootstrap constants are plugin-specific rather than short generic ACE names
  • plugin-owned admin page slugs are plugin-specific as well
  • internal plugin asset, admin, and REST bootstrap URLs are normalised so mapped multisite subsites do not accidentally inherit the primary domain

If I change any of that behaviour, I want the wiki and setup notes updated as part of the same work because those details directly affect live deployment and debugging.

Documentation expectations

I want the documentation to stay aligned across:

  • README.md
  • readme.txt
  • the GitHub wiki
  • AGENTS.md

If behaviour, setup, reporting surfaces, or roadmap position changes, the docs should be refreshed as part of the same piece of work.

Writing style

Documentation should stay in British English and read as though I wrote it.

GitHub issue comments and issue bodies can include the repository’s AI summary convention, but the wiki should read like normal project documentation and should not carry those summaries.

Clone this wiki locally