[docs] Add documentation on the new design system#1533
Open
andrewgos wants to merge 1 commit intomoodle:mainfrom
Open
[docs] Add documentation on the new design system#1533andrewgos wants to merge 1 commit intomoodle:mainfrom
andrewgos wants to merge 1 commit intomoodle:mainfrom
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
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 a new “Design System” documentation section to the General docs, intended as an entry point/bridge to the primary Design System resources (e.g., design.moodle.com and the GitHub repo).
Changes:
- Adds a new
designsystemsidebar and exposes it in the top navbar. - Introduces a new Design System landing page plus three initial pages: Overview, Getting started, and FAQ.
- Links out to the canonical external sources (GitHub README/Releases and design.moodle.com).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars/general.js | Adds a new designsystem sidebar category with autogenerated items and a category landing doc. |
| config/navbar.js | Adds a “Design System” navbar entry pointing at the new sidebar. |
| general/designsystem.md | New landing page with suggested reading path for the Design System section. |
| general/designsystem/overview.md | New overview page describing what/why of the Design System. |
| general/designsystem/getting-started.md | New getting-started page linking to setup, releases, and external docs. |
| general/designsystem/faq.md | New FAQ covering token adoption and product support scope. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
andrewgos
force-pushed
the
MDS-467-designsystem
branch
from
8455264 to
e6ec933
Compare
Chocolate-lightning
suggested changes
Mar 10, 2026
andrewgos
force-pushed
the
MDS-467-designsystem
branch
from
e6ec933 to
21e7e87
Compare
andrewgos
force-pushed
the
MDS-467-designsystem
branch
from
21e7e87 to
674badf
Compare
Chocolate-lightning
approved these changes
Mar 11, 2026
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.
As part of https://moodle.atlassian.net/browse/MDS-467
Creating a new space for any information related to the design system, so broader Moodle developers are aware of this and know how to get to it.
Note: Majority of the technical information of the design system package will live in design.moodle.com, this page will function as a bridge from other apps outside the designsystem (ie. the LMS)