From 2dcb3fd2ab5c60c98068c8f92dde740e0e45d94e Mon Sep 17 00:00:00 2001 From: Christopher Joe Date: Wed, 29 Nov 2017 14:28:42 +1300 Subject: [PATCH] Enhancement Add documentation for pattern library --- .../02_CMS_Architecture.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md index 2bd5bf72c..d2c4cec33 100644 --- a/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md +++ b/docs/en/02_Developer_Guides/15_Customising_the_Admin_Interface/02_CMS_Architecture.md @@ -41,7 +41,7 @@ Check our [build tooling](/contributing/build_tooling) docs for more details. ``` -(cd framework && yarn run build && yarn run css) +cd vendor/silverstripe/admin && yarn build ``` ## Coding Conventions @@ -50,6 +50,21 @@ Please follow our [CSS](/contributing/css_coding_conventions) and [JavaScript](/contributing/javascript_coding_conventions) coding conventions. + +## Pattern library + +A pattern library is a collection of user interface design elements, this helps developers and designers collaborate and to provide a quick preview of elements as they were intended without the need to build an entire interface to see it. +Components built in React and used by the CMS are actively being added to the pattern library. + +To access the pattern library, starting from your project root: + +``` +cd vendor/silverstripe/admin && yarn pattern-lib +``` + +Then browse to `http://localhost:6006/` + + ## The Admin URL The CMS interface can be accessed by default through the `admin/` URL. You can change this by setting your own [Director routing rule](director#routing-rules) to the `[AdminRootController](api:SilverStripe\Admin\AdminRootController)` and clear the old rule like in the example below.