[docs] Added initial docs for Composer-installed plugin guidance#1542
Open
andrewnicols wants to merge 1 commit intomoodle:mainfrom
Open
[docs] Added initial docs for Composer-installed plugin guidance#1542andrewnicols wants to merge 1 commit intomoodle:mainfrom
andrewnicols wants to merge 1 commit intomoodle:mainfrom
Conversation
✅ 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
Adds initial Moodle developer documentation for Composer-based plugin distribution/installation (introduced in Moodle 5.2), and wires this into the existing “Common files” reference so composer.json is documented consistently alongside other plugin files.
Changes:
- Add a new developer guide covering how to publish/install plugins via Composer, plus local development workflows.
- Add a
composer.jsonentry to the “Common files” API page using a newComposerJSONsummary component. - Link the new Composer guide from the main Developer Guides index.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/guides/composer/index.md | New guide describing plugin Composer packaging, publishing to Packagist, and development tips. |
| docs/guides.md | Adds the Composer guide to the Developer Guides list. |
| docs/apis/commonfiles/index.mdx | Adds a composer.json section to the common plugin files reference. |
| docs/apis/_files/index.tsx | Exposes the new ComposerJSON file summary component for use in MDX pages. |
| docs/apis/_files/composer-json.tsx | New ComponentFileSummary wrapper for composer.json. |
| docs/apis/_files/composer-json.mdx | New MDX description content for the composer.json common-file reference. |
This is developer documentation. User documentation will be added to the user docs.
andrewnicols
force-pushed
the
composerDev
branch
from
db23dad to
1ec9235
Compare
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.
This is developer documentation. User documentation will be added to the user docs.