Merged
Conversation
This change is required for Docusaurus 3.10 https://docusaurus.io/blog/releases/3.10#strict-admonitions
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the docs site content and configuration to be compatible with a Docusaurus 3.10 upgrade, primarily by adjusting MDX/Markdown syntax patterns that Docusaurus (and associated tooling) treats differently.
Changes:
- Updates many docs pages to add explicit section anchors and to adjust admonition/title syntax.
- Converts several HTML-comment directives (markdownlint/cspell) into MDX JSX-style comments.
- Updates Docusaurus/Yarn/cspell configuration to align with the new toolchain expectations.
Reviewed changes
Copilot reviewed 240 out of 1777 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| general/app_releases.md | Adds explicit section anchor markers to release headings |
| general/app/upgrading/index.md | Changes markdownlint directive comment syntax to MDX JSX comment |
| general/app/upgrading/acceptance-tests-upgrade-guide.md | Adds explicit section anchors to headings |
| general/app/faq.md | Adds explicit section anchors to FAQ headings |
| general/app/development/testing/unit-testing.md | Adds explicit section anchors to headings |
| general/app/development/testing/index.md | Changes markdownlint directive comment syntax to MDX JSX comment |
| general/app/development/testing/continuous-integration.md | Adds explicit section anchors to headings |
| general/app/development/setup/docker-images.md | Adds explicit section anchors to headings |
| general/app/development/setup/app-in-browser.md | Adds explicit section anchors and updates admonition title syntax |
| general/app/development/plugins-development-guide/troubleshooting.md | Adds explicit section anchors to headings |
| general/app/development/plugins-development-guide/examples/self-enrolment.md | Adds explicit section anchors to headings |
| general/app/development/plugins-development-guide/examples/question-types.md | Adds explicit section anchors to headings |
| general/app/development/plugins-development-guide/examples/link-handlers.md | Adds explicit section anchors to headings |
| general/app/development/plugins-development-guide/examples/index.md | Changes markdownlint directive comment syntax to MDX JSX comment |
| general/app/development/plugins-development-guide/examples/groups-selector.md | Adds explicit section anchors to headings |
| general/app/development/plugins-development-guide/examples/forms.md | Adds explicit section anchors to headings |
| general/app/development/plugins-development-guide/examples/course-modules.md | Converts an HTML comment in an example to MDX JSX comment; adds anchors |
| general/app/development/plugins-development-guide/examples/course-formats.md | Adds explicit section anchors; adjusts an internal anchor link |
| general/app/development/network-debug.md | Adds explicit section anchors to headings |
| general/app/development/link-handling/index.md | Changes markdownlint directive comment syntax to MDX JSX comment |
| general/app/development/link-handling/deep-linking.md | Adds explicit section anchors to headings |
| general/app/development/link-handling/app-links.md | Adds explicit section anchors; updates admonition title syntax |
| general/app/development/index.md | Changes markdownlint directive comment syntax to MDX JSX comment |
| general/app/development/custom-push-notifications.md | Changes cspell directive comment syntax to MDX JSX comment; adds anchors |
| general/app/development/accessibility.md | Adds explicit section anchors to headings |
| general/app/customisation/index.md | Adds explicit section anchors to headings |
| docusaurus.config.js | Updates Docusaurus “future” flags; relocates broken-markdown-link handling; removes Zipchat script injection |
| docs/intro.md | Updates admonition title syntax |
| docs/guides/restructure/index.md | Adds explicit section anchors; updates admonition title syntax |
| docs/guides/javascript/yui/namespacing.md | Adds explicit section anchors to headings |
| docs/guides/javascript/yui/modules.md | Adds anchors; converts a cspell directive comment to MDX JSX comment |
| docs/guides/javascript/yui/index.md | Adds anchors; converts cspell directives to MDX JSX comments |
| docs/guides/javascript/react/profiler.md | Adds explicit section anchors to headings |
| docs/guides/javascript/react/index.md | Adds explicit section anchors to headings |
| docs/guides/javascript/react/importmap.md | Adds explicit section anchors to headings |
| docs/guides/javascript/react/buildtools.md | Adds explicit section anchors to headings |
| docs/guides/javascript/modules.md | Adds explicit section anchors to headings |
| docs/guides/javascript/modal/index.md | Adds anchors; updates admonition title syntax |
| docs/guides/javascript/jquery/index.md | Adds explicit section anchors to headings |
| docs/guides/javascript/comboboxsearch/examples.md | Adds explicit section anchors to headings |
| docs/guides/javascript/ajax/index.md | Adds explicit section anchors to headings |
| docs/guides/composer/index.md | Adds anchors; updates admonition title syntax |
| docs/gettingstarted/requirements.md | Adds explicit section anchors to headings |
| docs/devupdate.md | Changes markdownlint directive comment syntax to MDX JSX comment; adds anchors |
| docs/apis/subsystems/time/index.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/task/scheduled.md | Adds anchors; converts markdownlint directive comment to MDX JSX comment |
| docs/apis/subsystems/task/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/task/adhoc.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/sms/index.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/routing/testing.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/routing/shortlinks.md | Converts cspell directives to MDX JSX comments; adds anchors |
| docs/apis/subsystems/routing/responses.md | Updates admonition title syntax; adds anchors |
| docs/apis/subsystems/routing/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/roles.md | Adds anchors; converts cspell directive; updates admonition title syntax |
| docs/apis/subsystems/question/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/privacy/utils.md | Updates admonition title syntax; adds anchors |
| docs/apis/subsystems/privacy/faq.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/plagiarism.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/output/inplace.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/output/humandate.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/group/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/form/usage/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/form/fields/choicedropdown.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/form/advanced/repeat-elements.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/form/advanced/no-submit-button.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/form/advanced/checkbox-controller.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/form/advanced/advanced-elements.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/files/converter.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/files/browsing.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/favourites/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/external/testing.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/external/security.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/external/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/external/functions.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/external/files.md | Adds anchors; updates admonition title syntax |
| docs/apis/subsystems/external/description.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/external/advanced/custom-services.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/editor/index.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/badges/index.md | Converts cspell directive to MDX JSX comment; adds anchors |
| docs/apis/subsystems/backup/restore.md | Adds explicit section anchors to headings |
| docs/apis/subsystems/availability/index.md | Adds anchors; updates admonition title syntax |
| docs/apis/plugintypes/tiny/testing.md | Adds anchors; updates admonition title syntax |
| docs/apis/plugintypes/theme/styles.md | Adds anchors; updates admonition title syntax |
| docs/apis/plugintypes/theme/layout.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/theme/images.md | Adds anchors; updates admonition title syntax |
| docs/apis/plugintypes/theme/fonts.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/theme/_examples/lang.md | Converts markdownlint/cspell directives to MDX JSX comments |
| docs/apis/plugintypes/sms/index.md | Adds anchors; updates admonition title syntax |
| docs/apis/plugintypes/quizaccess/index.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/quizaccess/_examples/rule_overridable.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/quizaccess/_examples/rule.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/qtype/restore.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/qtype/newquestiondefaults.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/mod_data/presets.md | Converts cspell directive to MDX JSX comment; adds anchors |
| docs/apis/plugintypes/mod_data/fields.md | Adds anchors; updates admonition title syntax |
| docs/apis/plugintypes/mod/visibility.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/mod/index.mdx | Adds explicit section anchors to headings |
| docs/apis/plugintypes/mod/activitymodule.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/mod/_files/view-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/mod/_files/mod_form-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/mod/_files/lib_description.md | Converts markdownlint directive to MDX JSX comment; adds anchors |
| docs/apis/plugintypes/mod/_files/install_description.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/mod/_files/index-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/mod/_files/access_description.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/mlbackend/index.md | Converts cspell directives to MDX JSX comment; adds anchors |
| docs/apis/plugintypes/logstore/index.md | Converts cspell directive to MDX JSX comment |
| docs/apis/plugintypes/local/index.mdx | Adds explicit section anchors to headings |
| docs/apis/plugintypes/filter/index.md | Converts cspell and markdownlint directives to MDX JSX comments; adds anchors |
| docs/apis/plugintypes/fileconverter/index.md | Adds explicit section anchors to headings |
| docs/apis/plugintypes/fileconverter/_files/converter.md | Converts markdownlint/cspell directives to MDX JSX comments |
| docs/apis/plugintypes/customfield/index.md | Converts markdownlint directives to MDX JSX comments; adds explicit anchors |
| docs/apis/plugintypes/availability/index.md | Adds explicit anchors |
| docs/apis/plugintypes/availability/_examples/lang.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/atto/index.md | Updates admonition title syntax; adds anchors; converts markdownlint directive |
| docs/apis/plugintypes/atto/_examples/lib.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/atto/_examples/button.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/plugintypes/antivirus/index.mdx | Converts cspell directives to MDX JSX comment; adds anchors |
| docs/apis/plugintypes/antivirus/_files/scanner-php.mdx | Converts markdownlint/cspell directives to MDX JSX comments |
| docs/apis/plugintypes/ai/provider.md | Updates admonition title syntax; adds explicit anchors |
| docs/apis/plugintypes/ai/placement.md | Updates admonition title syntax; adds explicit anchors |
| docs/apis/plugintypes/ai/index.md | Adds explicit anchors |
| docs/apis/core/preference/index.md | Adds explicit section anchors to headings |
| docs/apis/core/message/index.md | Adds explicit section anchors to headings |
| docs/apis/core/lock/index.md | Adds explicit section anchors to headings |
| docs/apis/core/htmlwriter/index.md | Adds explicit section anchors to headings |
| docs/apis/core/grading/index.md | Adds explicit section anchors to headings |
| docs/apis/core/dml/exceptions.md | Adds explicit section anchors to headings |
| docs/apis/core/dml/drivers.md | Adds explicit section anchors to headings |
| docs/apis/core/dml/delegated-transactions.md | Adds explicit section anchors to headings |
| docs/apis/core/dml/ddl.md | Adds explicit section anchors to headings |
| docs/apis/core/di/index.md | Updates admonition title syntax; adds explicit anchors |
| docs/apis/core/deprecation/index.md | Converts markdownlint directive to MDX JSX comment; adds anchors |
| docs/apis/core/customfields/index.md | Updates admonition title syntax; adds explicit anchors |
| docs/apis/core/comment/index.md | Adds explicit section anchors to headings |
| docs/apis/core/clock/index.md | Updates admonition title syntax; adds explicit anchors |
| docs/apis/commonfiles/version.php/index.md | Adds explicit section anchors to headings |
| docs/apis/commonfiles/tag.php/index.md | Adds explicit section anchors to headings |
| docs/apis/commonfiles/index.mdx | Converts markdownlint directive to MDX JSX comment; adds explicit anchors |
| docs/apis/commonfiles/db-tasks.php/index.md | Updates admonition title syntax; adds explicit anchors |
| docs/apis/_files/yui-dir.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/version-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/upgrade-txt.mdx | Converts markdownlint directive to MDX JSX comment; adds anchors |
| docs/apis/_files/upgrade-php.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/thirdpartylibs-xml.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/styles-css.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/settings-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/readme_moodle-txt.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/readme.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/pix-dir.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/locallib.mdx | Converts markdownlint/cspell directives to MDX JSX comments; updates admonition title syntax |
| docs/apis/_files/lib.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/lang.md | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/lang-extra.md | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/environment-xml.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-upgrade-php.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/db-uninstall-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-tasks-php.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/db-services-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-renamedclasses-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-mobile-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-messages-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-legacyclasses-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-install-xml.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-install-php.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/db-events-php.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/db-access-php.mdx | Converts markdownlint directive to MDX JSX comment; updates admonition title syntax |
| docs/apis/_files/composer-json.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/cli-dir.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/classes-dir.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/changes.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/backup-dir.mdx | Converts markdownlint directive to MDX JSX comment |
| docs/apis/_files/amd-dir.mdx | Converts markdownlint directive to MDX JSX comment |
| cspell.config.js | Adds regex to ignore MDX JSX comment blocks |
| README.md | Replaces HTML comments with MDX JSX comments in a non-MDX file |
| .yarnrc.yml | Updates yarnPath to Yarn 4.13.0 |
Comment on lines
+4
to
+5
| {/* <!--<a href="CONTRIBUTING.md#pull-requests"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>--> */} | ||
| {/* <!--<a href="#license"><img src="https://img.shields.io/github/license/sourcerer-io/hall-of-fame.svg?colorB=ff0000"></a>--> */} |
There was a problem hiding this comment.
README.md is rendered by GitHub as plain Markdown (not MDX), so {/* ... */} will display as literal text instead of acting as a comment. Revert these back to standard HTML comments (<!-- ... -->) so the README renders correctly on GitHub.
| --- | ||
|
|
||
| <!-- markdownlint-disable no-inline-html --> | ||
| {/* <!-- markdownlint-disable no-inline-html --> */} |
There was a problem hiding this comment.
markdownlint directives are only recognized in HTML comments (e.g. <!-- markdownlint-disable ... -->). Wrapping them in an MDX JSX comment ({/* ... */}) will prevent markdownlint from seeing the directive, which can reintroduce lint failures for inline HTML/MDX. Use the standard HTML comment form for markdownlint directives, or update the lint tooling/config to support the new syntax consistently.
Suggested change
| {/* <!-- markdownlint-disable no-inline-html --> */} | |
| <!-- markdownlint-disable no-inline-html --> |
| --- | ||
|
|
||
| ## Moodle App 5.x | ||
| ## Moodle App 5.x {/* #moodle-app-5x */} |
There was a problem hiding this comment.
If the intent is to set explicit heading IDs for stable anchors, {/* ... */} is a JSX comment and will not assign an id to the heading in standard Markdown/MDX processing. Use Docusaurus' supported explicit heading ID syntax (e.g. ## Moodle App 5.x {#moodle-app-5x}) so the anchors are actually applied.
| | [Moodle App 5.0.0](./app_releases/v5/v5.0.0) | 27 June 2025 | | ||
|
|
||
| ## Moodle App 4.x | ||
| ## Moodle App 4.x {/* #moodle-app-4x */} |
There was a problem hiding this comment.
If the intent is to set explicit heading IDs for stable anchors, {/* ... */} is a JSX comment and will not assign an id to the heading in standard Markdown/MDX processing. Use Docusaurus' supported explicit heading ID syntax (e.g. ## Moodle App 5.x {#moodle-app-5x}) so the anchors are actually applied.
| - On 4.5.0 the app was based on Ionic 8 version. | ||
|
|
||
| ## Moodle App 3.x | ||
| ## Moodle App 3.x {/* #moodle-app-3x */} |
There was a problem hiding this comment.
If the intent is to set explicit heading IDs for stable anchors, {/* ... */} is a JSX comment and will not assign an id to the heading in standard Markdown/MDX processing. Use Docusaurus' supported explicit heading ID syntax (e.g. ## Moodle App 5.x {#moodle-app-5x}) so the anchors are actually applied.
Comment on lines
+128
to
+130
| ## Using JavaScript {/* #using-JavaScript */} | ||
|
|
||
| You can also register custom formats using [JavaScript initialisation](../index.md#javascript-initialisation). | ||
| You can also register custom formats using [JavaScript initialisation](../index.md#JavaScript-initialisation). |
There was a problem hiding this comment.
This changes the in-page anchor in a way that is likely to break navigation: (1) the heading ID mechanism used here ({/* ... */}) doesn't set an id, and (2) the linked fragment uses different casing (#JavaScript-initialisation) than typical generated slugs. Prefer a real explicit ID on the target heading (using {#...} syntax) and use a consistently lowercase, stable fragment in the link to avoid broken anchors.
| @for (section of sections; track $index) { | ||
| @if (section.id in CONTENT_OTHERDATA.displaysections) { | ||
| <!-- code to display the section goes here --> | ||
| {/* <!-- code to display the section goes here --> */} |
There was a problem hiding this comment.
This line appears inside an html fenced code example; replacing a normal HTML comment with an MDX JSX comment makes the example misleading/invalid for the language being demonstrated. Keep language-appropriate comments inside fenced code blocks (e.g. <!-- ... --> for HTML) so readers can copy/paste examples without unexpected syntax.
Suggested change
| {/* <!-- code to display the section goes here --> */} | |
| <!-- code to display the section goes here --> |
| ``` | ||
|
|
||
| ### Peer dependenices | ||
| ### Peer dependenices {/* #peer-dependenices */} |
There was a problem hiding this comment.
Correct the typo in the heading: 'dependenices' → 'dependencies' (and update the anchor accordingly if you keep an explicit ID).
Suggested change
| ### Peer dependenices {/* #peer-dependenices */} | |
| ### Peer dependencies {/* #peer-dependencies */} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.