diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 36947041b2..519eae5126 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -6,5 +6,6 @@ Contributing to Wagtail :maxdepth: 2 developing + styleguide css_guidelines javascript_guidelines diff --git a/docs/contributing/styleguide.rst b/docs/contributing/styleguide.rst new file mode 100644 index 0000000000..fd5231fdc6 --- /dev/null +++ b/docs/contributing/styleguide.rst @@ -0,0 +1,18 @@ +Styleguide +========== + +Developers working on the Wagtail UI or creating new UI components may wish to test their work against our Styleguide, which is provided as the contrib module "wagtailstyleguide". + +To install the styleguide module on your site, add it to the list of ``INSTALLED_APPS`` in your settings: + +.. code-block:: python + + INSTALLED_APPS = ( + ... + 'wagtail.contrib.wagtailstyleguide', + ... + ) + +At present the styleguide is static: new UI components must be added to it manually, and there are no hooks into it for other modules to use. We hope to support hooks in the future. + +The styleguide doesn't currently provide examples of all the core interface components; notably the Page, Document, Image and Snippet chooser interfaces are not currently represented. \ No newline at end of file diff --git a/docs/getting_started/trying_wagtail.rst b/docs/getting_started/demo_site.rst similarity index 100% rename from docs/getting_started/trying_wagtail.rst rename to docs/getting_started/demo_site.rst diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst index 8b72c02069..e308574f71 100644 --- a/docs/getting_started/index.rst +++ b/docs/getting_started/index.rst @@ -5,7 +5,7 @@ Getting started .. toctree:: :maxdepth: 2 - trying_wagtail installation creating_your_project using_vagrant + demo_site diff --git a/docs/index.rst b/docs/index.rst index 5a66264282..ae6e4d63a0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ Below are some useful links to help you get started with Wagtail. * **First steps** - * :doc:`getting_started/trying_wagtail` + * :doc:`getting_started/demo_site` * :doc:`getting_started/installation` * :doc:`getting_started/creating_your_project`