From 50155ee7774d645aa9b5af2412a8735070893c7f Mon Sep 17 00:00:00 2001 From: erseco Date: Fri, 14 Aug 2026 15:38:20 +0200 Subject: [PATCH] docs(readme): document source-code locations and build tools for the bundled editor MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit WordPress.org's detailed plugin guideline 4 (human-readable code) accepts minified/compiled code when the readme links the development location and its build tools. The plugin bundles the compiled eXeLearning editor (dist/static: minified bundles, compiled stylesheets, compressed data files), but readme.txt only linked this repository. Add a Source Code section stating that the plugin's own PHP/JS ship as readable source, pointing to https://github.com/exelearning/exelearning for the editor's source and build (make build-static), and noting that each release records the bundled editor version (.editor-version) and exact source commit (dist/static/.build-commit) — both files ship in the release package. Also documents how release ZIPs are assembled (make package / wp dist-archive). --- readme.txt | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/readme.txt b/readme.txt index 336ba50..041d5a2 100644 --- a/readme.txt +++ b/readme.txt @@ -43,6 +43,18 @@ 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 = @@ -50,3 +62,4 @@ Yes. The plugin exposes actions and filters (all prefixed with `exelearning_`) f * 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).