Skip to content

Commit 330594e

Browse files
authored
Merge pull request #1533 from andrewgos/MDS-467-designsystem
[docs] Add documentation on the new design system
2 parents 790a28d + 8a720ec commit 330594e

6 files changed

Lines changed: 97 additions & 0 deletions

File tree

CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222
/general/app_releases/ @moodle/mobile-developers
2323
/general/app/ @moodle/mobile-developers
2424

25+
# Design System
26+
/general/designsystem/ @moodle/design-system
27+
2528
# Content Guideline Owners
2629
/general/contentguidelines/ @moodle/content-authors
2730

config/navbar.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,13 @@ const navbar = {
7070
label: 'Moodle App',
7171
docsPluginId: 'general',
7272
},
73+
{
74+
type: 'docSidebar',
75+
position: 'left',
76+
sidebarId: 'designsystem',
77+
label: 'Design System',
78+
docsPluginId: 'general',
79+
},
7380
{
7481
type: 'docSidebar',
7582
position: 'left',

general/designsystem/faq.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: FAQ
3+
sidebar_position: 3
4+
tags:
5+
- Design System
6+
---
7+
8+
## How is the Design System rollout being phased?
9+
10+
The current phase is focused on defining and rolling out design tokens first.
11+
12+
Component development is planned as the next phase, with an aim to begin shipping Moodle Design System components in Moodle 5.3.
13+
14+
## What practical changes in Moodle Core LMS are expected with the introduction of tokens?
15+
16+
[MDL-87729](https://moodle.atlassian.net/browse/MDL-87729) will determine this. However, variables and hard-coded values in core Moodle themes will likely be replaced or removed to reference the Design System tokens as the living source of truth.
17+
18+
## Will MoodleHQ adopt the usage of tokens going forward?
19+
20+
Yes. We aim to use tokens in new feature development where appropriate.
21+
22+
The Design System team plans to track adoption over time. Updating existing code falls under the responsibility of product owners within Moodle Core LMS, not the Design System team. Consequently, automated checks for code contributions to Moodle Core LMS may change.
23+
24+
## Does the Design System support the Moodle App or Moodle Workplace?
25+
26+
Not yet. This includes Moodle Workplace tenant theming. We have not collaborated with these Moodle products, but aim to do so in the future.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Getting started
3+
sidebar_position: 2
4+
tags:
5+
- Design System
6+
---
7+
8+
Use the resources below to start working with the Moodle Design System.
9+
10+
## Setup and installation
11+
12+
Follow the official setup steps in the [GitHub README](https://github.com/moodlehq/design-system#readme).
13+
14+
## Releases and changelog
15+
16+
Track published versions and release notes on [GitHub Releases](https://github.com/moodlehq/design-system/releases) and [NPM package](https://www.npmjs.com/package/@moodlehq/design-system).
17+
18+
## Issues and bug reports
19+
20+
For issue reporting guidelines and contribution workflow, see [GitHub CONTRIBUTING](https://github.com/moodlehq/design-system/blob/main/.github/CONTRIBUTING.md).
21+
22+
## Design documentation
23+
24+
Browse usage guidance and design documentation at [design.moodle.com](https://design.moodle.com).
25+
26+
Feedback and suggestions for design-related topics can be submitted using the feedback form there.

general/designsystem/overview.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Overview
3+
sidebar_position: 1
4+
tags:
5+
- Design System
6+
---
7+
8+
## The Moodle Design System
9+
10+
The Moodle Design System is a shared foundation of design principles, reusable components, and token-based styling rules for building Moodle interfaces across the ecosystem.
11+
12+
It gives teams one common reference for how UI should look, behave, and scale across products and features, helping interfaces feel consistently Moodle while improving the platform's long-term maintainability.
13+
14+
## Why a Design System is needed
15+
16+
Without a Design System, teams face recurring challenges:
17+
18+
- Design decisions are not centrally defined, so translating design into code often requires repeated interpretation.
19+
- Similar UI patterns have been implemented differently across Moodle features and releases, making consistency harder to maintain.
20+
- Styling values are maintained in multiple places (files, themes, and overrides), increasing maintenance effort and making updates harder to apply consistently.
21+
- As Moodle LMS and its ecosystem grow, teams and contributors need stronger shared foundations to maintain both speed and consistency.
22+
23+
Design tokens introduce shared, reusable values that help address these challenges.
24+
25+
## Relationship with Bootstrap
26+
27+
The Moodle Design System does not aim to replace Bootstrap. It works alongside Bootstrap by defining Moodle-specific design decisions in one place.
28+
29+
Instead of scattering hardcoded values across different files and components, we aim to maintain an authoritative set of design tokens. Those tokens can then be applied consistently across Bootstrap-based implementations and Moodle UI code.

sidebars/general.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,12 @@ const sidebars = {
157157
},
158158
},
159159
],
160+
designsystem: [
161+
{
162+
type: 'autogenerated',
163+
dirName: 'designsystem',
164+
},
165+
],
160166
contentguidelines: [
161167
{
162168
label: 'Content guidelines',

0 commit comments

Comments
 (0)