[docs] Add documentation on the new design system#1533
[docs] Add documentation on the new design system#1533andrewnicols merged 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. |
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.
8455264 to
e6ec933
Compare
e6ec933 to
21e7e87
Compare
21e7e87 to
674badf
Compare
|
I recommend adding I'd also suggest moving Then any changes to docs are within your own team's control. |
674badf to
dec4630
Compare
dec4630 to
8a720ec
Compare
|
Great suggestions @andrewnicols, thanks! With Hence, I've removed the I've also added the codeowners. Over to you for a review. |
|
That all looks good to me. Now that this is in, you should have the ability to approve and merge changes to Note: If you add a patch which also includes other areas you'll need someone else to review those areas too. |
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)