-
Notifications
You must be signed in to change notification settings - Fork 571
[docs] Add documentation on the new design system #1533
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
andrewgos
wants to merge
1
commit into
moodle:main
Choose a base branch
from
andrewgos:MDS-467-designsystem
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Design system | ||
| tags: | ||
| - Design System | ||
| --- | ||
|
|
||
| Welcome to the Moodle Design System documentation. | ||
|
|
||
| This section provides an introduction to the Design System and links to the key resources for working with it. | ||
|
|
||
| If you are new to this area, begin with the overview to understand the Design System foundations, why they are needed, and how they relate to Bootstrap. | ||
|
|
||
| ## Suggested reading path | ||
|
|
||
| 1. Start with [Overview](./designsystem/overview.md) for context and guiding principles. | ||
| 2. Continue with [Getting started](./designsystem/getting-started.md) for setup and adoption resources. | ||
| 3. Check [FAQ](./designsystem/faq.md) for answers to common implementation and rollout questions. | ||
|
|
||
| If you are looking for practical implementation resources, go directly to [Getting started](./designsystem/getting-started.md). |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: FAQ | ||
| sidebar_position: 3 | ||
| tags: | ||
| - Design System | ||
| --- | ||
|
|
||
| ## How is the Design System rollout being phased? | ||
|
|
||
| The current phase is focused on defining and rolling out design tokens first. | ||
|
|
||
| Component development is planned as the next phase, with an aim to begin shipping Moodle Design System components in Moodle 5.3. | ||
|
|
||
| ## What practical changes in Moodle Core LMS are expected with the introduction of tokens? | ||
|
|
||
| [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. | ||
|
|
||
| ## Will MoodleHQ adopt the usage of tokens going forward? | ||
|
|
||
| Yes. We aim to use tokens in new feature development where appropriate. | ||
|
|
||
| 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. | ||
|
|
||
| ## Does the Design System support the Moodle App or Moodle Workplace? | ||
|
|
||
| Not yet. This includes Moodle Workplace tenant theming. We have not collaborated with these Moodle products, but aim to do so in the future. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| --- | ||
| title: Getting started | ||
| sidebar_position: 2 | ||
| tags: | ||
| - Design System | ||
| --- | ||
|
|
||
| Use the resources below to start working with the Moodle Design System. | ||
|
|
||
| ## Setup and installation | ||
|
|
||
| Follow the official setup steps in the [GitHub README](https://github.com/moodlehq/design-system#readme). | ||
|
|
||
| ## Releases and changelog | ||
|
|
||
| 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). | ||
|
|
||
| ## Issues and bug reports | ||
|
|
||
| For issue reporting guidelines and contribution workflow, see [GitHub CONTRIBUTING](https://github.com/moodlehq/design-system/blob/main/.github/CONTRIBUTING.md). | ||
|
|
||
andrewgos marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## Design documentation | ||
|
|
||
| Browse usage guidance and design documentation at [design.moodle.com](https://design.moodle.com). | ||
|
|
||
| Feedback and suggestions for design-related topics can be submitted using the feedback form there. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
andrewgos marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| title: Overview | ||
| sidebar_position: 1 | ||
| tags: | ||
| - Design System | ||
| --- | ||
|
|
||
| ## The Moodle Design System | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
|
|
||
| ## Why a Design System is needed | ||
|
|
||
| Without a Design System, teams face recurring challenges: | ||
|
|
||
| - Design decisions are not centrally defined, so translating design into code often requires repeated interpretation. | ||
| - Similar UI patterns have been implemented differently across Moodle features and releases, making consistency harder to maintain. | ||
| - Styling values are maintained in multiple places (files, themes, and overrides), increasing maintenance effort and making updates harder to apply consistently. | ||
| - As Moodle LMS and its ecosystem grow, teams and contributors need stronger shared foundations to maintain both speed and consistency. | ||
|
|
||
| Design tokens introduce shared, reusable values that help address these challenges. | ||
|
|
||
| ## Relationship with Bootstrap | ||
|
|
||
| The Moodle Design System does not aim to replace Bootstrap. It works alongside Bootstrap by defining Moodle-specific design decisions in one place. | ||
|
|
||
| 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. | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.