[docs] Add developer documentation for course linear navigation support#1634
Conversation
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds Moodle DevDocs documentation for the new “course linear navigation” feature in Moodle 5.3, describing how third-party course formats can opt in and integrate with the footer navigation controls.
Changes:
- Adds a Moodle 5.3 developer update entry introducing linear navigation support and linking to a new guide.
- Introduces a new format plugin guide covering opt-in, configuration, page-state controls, and Behat steps.
- Updates the course format plugin API index to mention
uses_linear_navigation()and link to the new guide.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 11 comments.
| File | Description |
|---|---|
| docs/devupdate.md | Adds a 5.3 dev update entry and links to the new linear navigation guide. |
| docs/apis/plugintypes/format/linear_navigation.md | New integration guide for course formats to support linear navigation. |
| docs/apis/plugintypes/format/index.md | Adds API references/cross-linking for the linear navigation feature. |
aanabit
left a comment
aanabit
left a comment
There was a problem hiding this comment.
I'm not sure we should also mention the set_suplementary_content().
Even though it's not specific part of the linear navigation it's somehow related.
I'm not saying we should "mix" both things, but I thing a thought or discussion about it is worthy.
Apart from that, I've added a couple of tiny things only.
Thanks for working on this.
Document the implementation details for third-party course formats to opt into and support the new course linear navigation mechanism introduced in MDL-87302 and MDL-87575.
I think we can create a separate pull-request to document this feature too (but I would do it separately, because it's not related to the course navigation feature) :-)
Thanks! I reviewed them and updated the patch accordingly in some cases. |
aanabit
left a comment
aanabit
left a comment
There was a problem hiding this comment.
The changes seem OK and the new documentation is ready to land.
Thanks for your work.
Amaia
Document the implementation details for third-party course formats to opt into and support the new course linear navigation mechanism introduced in MDL-87302 and MDL-87575.