Update Component Library documentation #1204
Merged
Conversation
This file contains 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
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
sarjona
force-pushed
the
update-component-library-docs
branch
from
fee56f3 to
11a1a3c
Compare
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.
Changes Description:
I made some changes to improve the clarity and consistency of the original text. I also changed the first part of the text to clarify the purpose of the Component Library. I also added details on ‘Getting Started’ and ‘Building the Component Library’ to make them more tutorial and organized. I also made it more explicit about who the library is suitable for and how developers, UX developers, and visual designers can use it.
These are aimed at improving the look and the content of this document for the benefit of anyone who approaches Moodle development and the Component Library with limited or no background knowledge at all.