Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-03-24 01:40:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

moved styleguide to own page. renamed trying wagtail to demo site

Browse source
This commit is contained in:
Dave Cranwell 2015-05-14 14:02:06 +01:00 committed by Karl Hobley
parent f42e06c455
commit bf6607de54
5 changed files with 21 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/contributing/index.rst
View file

@ -6,5 +6,6 @@ Contributing to Wagtail
:maxdepth: 2
developing
styleguide
css_guidelines
javascript_guidelines

18
docs/contributing/styleguide.rst Normal file
View file

@ -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.

0
docs/getting_started/trying_wagtail.rst → docs/getting_started/demo_site.rst
View file

2
docs/getting_started/index.rst
View file

@ -5,7 +5,7 @@ Getting started
.. toctree::
:maxdepth: 2
trying_wagtail
installation
creating_your_project
using_vagrant
demo_site

2
docs/index.rst
View file

@ -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`