Skip to content

[docs] Add documentation on the new design system#1533

Merged
andrewnicols merged 1 commit intomoodle:mainfrom
andrewgos:MDS-467-designsystem
Mar 19, 2026
Merged

[docs] Add documentation on the new design system#1533
andrewnicols merged 1 commit intomoodle:mainfrom
andrewgos:MDS-467-designsystem

Conversation

@andrewgos
Copy link
Copy Markdown
Contributor

@andrewgos andrewgos commented Mar 9, 2026

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)

Copilot AI review requested due to automatic review settings March 9, 2026 16:40
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 9, 2026

Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 8a720ec
🔍 Latest deploy log https://app.netlify.com/projects/moodledevdocs/deploys/69bb63e7d81c7d0008bdbe58
😎 Deploy Preview https://deploy-preview-1533--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 designsystem sidebar 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 andrewgos force-pushed the MDS-467-designsystem branch from 8455264 to e6ec933 Compare March 10, 2026 01:11
@andrewnicols
Copy link
Copy Markdown
Member

I recommend adding design-system to https://github.com/moodle/devdocs/blob/main/CODEOWNERS

# Content Guideline Owners
/general/designsystem/ @moodle/design-system

I'd also suggest moving /general/designsystem.md to /general/designsystem/index.md so that everything is in your team's control.

Then any changes to docs are within your own team's control.

@andrewgos andrewgos force-pushed the MDS-467-designsystem branch from 674badf to dec4630 Compare March 19, 2026 02:47
@andrewgos andrewgos requested a review from a team as a code owner March 19, 2026 02:47
@andrewgos andrewgos force-pushed the MDS-467-designsystem branch from dec4630 to 8a720ec Compare March 19, 2026 02:48
@andrewgos
Copy link
Copy Markdown
Contributor Author

Great suggestions @andrewnicols, thanks!

With /general/designsystem/index.md being at the root of the sidebar entry, it isn't playing nicely when it is a category along with autogenerated, it just duplicates index.md as another entry, and is not able to capture it as the head of the category. The alternative is to dump autogenerated and do the manual sidebar entries.

Hence, I've removed the /general/designsystem.md since the content of it seems redundant anyway, and might be worth chasing the setup of autogenerated instead.

I've also added the codeowners. Over to you for a review.

@andrewnicols
Copy link
Copy Markdown
Member

That all looks good to me.

Now that this is in, you should have the ability to approve and merge changes to /general/designsystem.

Note: If you add a patch which also includes other areas you'll need someone else to review those areas too.

@andrewnicols andrewnicols added this pull request to the merge queue Mar 19, 2026
Merged via the queue into moodle:main with commit 330594e Mar 19, 2026
6 checks passed
@andrewgos andrewgos deleted the MDS-467-designsystem branch March 19, 2026 03:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants