Skip to content

docs(readme): document source-code locations and build tools for the bundled editor #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erseco wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs(readme): document source-code locations and build tools for the bundled editor #101

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50155ee
docs(readme): document source-code locations and build tools for the …
erseco Aug 14, 2026
7298535
Merge branch 'main' into docs/readme-source-code-location
erseco Aug 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,23 @@ Use `screenshot="poster"` to show the screenshot as a clickable poster that load

Yes. The plugin exposes actions and filters (all prefixed with `exelearning_`) for ELPX extraction, metadata, REST saves, shortcode rendering and styles. See https://github.com/exelearning/wp-exelearning/blob/main/docs/HOOKS.md.

== Source Code ==

The plugin's own PHP and JavaScript ship as human-readable source in this package.

The bundled eXeLearning editor (the `dist/static` directory) is a compiled artifact: minified JavaScript bundles, compiled stylesheets, and compressed non-executable data files (curricular datasets and editor data shipped as `*.json.zst`/`*.json.gz`, decoded in the browser by the bundled `fzstd` library). Its complete, non-compiled source code and build tools are publicly maintained at:

https://github.com/exelearning/exelearning

Each plugin release records the bundled editor version in the `.editor-version` file and the exact source commit in `dist/static/.build-commit`. The editor is built reproducibly from that repository with `make build-static` (Bun; see `scripts/build-static-bundle.ts`).

The plugin itself is developed at https://github.com/exelearning/wp-exelearning. Release packages are produced with `make package`, which builds the editor from source (`make build-editor`) and assembles the ZIP with `wp dist-archive`.

== Changelog ==

= 0.0.0 =
* Initial release
* Add developer lifecycle hooks (actions and filters) for ELPX extraction, metadata, REST saves, shortcode rendering, and styles. See docs/HOOKS.md.
* The embedded editor is bundled exclusively in release packages; the runtime editor installer/updater was removed (ADR-72-01).
* Shortcode viewer: add a `fullscreen` attribute to show/hide the fullscreen button, support percentage `height` values, and render the Download and Fullscreen toolbar controls consistently with accessible names and correctly enqueued frontend styles and Dashicons.
* readme: add a Source Code section documenting the public repositories and build tools for the bundled compiled editor and the plugin (WordPress.org human-readable-code guideline).