diff --git a/docs/devupdate.md b/docs/devupdate.md index f7f64abe1..cf1fc319a 100644 --- a/docs/devupdate.md +++ b/docs/devupdate.md @@ -20,3 +20,17 @@ To address these challenges, we're reorganising the API to significantly improve - Refactor JSON exporters to support multiple Open Badges schema versions (MDL-85621). This will allow for seamless integration with different schema requirements. More information about the Badges API can be found in the [Badges API documentation](./apis/subsystems/badges/index.md). + +## Activity chooser descriptions refinement + + + +The help descriptions within the Activity Chooser have been significantly updated for all core Activities and Resources to provide richer guidance: + +- A new optional language string, `modulename_summary`, has been introduced to define a concise, single-paragraph introduction to the module. +- The existing `modulename_help` string has been refined to contain the detailed description, now structured with dedicated sections for: + - **Key features** to highlight the module's primary functionalities. + - **Ways to use it** to provide practical, application-focused examples. +- A new optional string, `modulename_tip`, is available for a supplemental section for best practices, advice, or effective usage tips. + +Third-party activity modules and resources can adopt the same structure by adding these language strings (`modulename_summary`, `modulename_help`, and `modulename_tip`) to their plugin's language files. These strings should be placed in the plugin's language file, for example, `mod/pluginname/lang/en/pluginname.php`.