From 045879b0363bcca324d7187a9a370e04afa4ba7a Mon Sep 17 00:00:00 2001 From: jlukic Date: Fri, 25 Oct 2013 15:11:48 -0400 Subject: [PATCH] updates docs --- server/documents/elements/button.html.eco | 85 +++++++++++++++++++ server/documents/elements/input.html.eco | 4 +- .../documents/project/contributing.html.eco | 49 ++++++----- server/documents/project/development.html.eco | 52 +++++++----- 4 files changed, 144 insertions(+), 46 deletions(-) diff --git a/server/documents/elements/button.html.eco b/server/documents/elements/button.html.eco index c17e88e65..ec2f15765 100755 --- a/server/documents/elements/button.html.eco +++ b/server/documents/elements/button.html.eco @@ -29,6 +29,31 @@ type : 'UI Element' +
+

Animated

+

A button can animate to show hidden content

+
The button will be automatically sized according to the visible content size. Make sure there is enough room for the hidden content to show
+
+
Next
+ +
+
+ +
+ +
+
+
+
Buy
+ +
+
+ +

Icon

A button can have only an icon

@@ -61,6 +86,23 @@ type : 'UI Element'
+
+

Icons

+

Button groups can show groups of icons

+
+
+
+
+
+
+
+
+
+
+
+
+ +

Conditionals

Button groups can be separated by conditionals

@@ -340,11 +382,54 @@ type : 'UI Element'

Sizes

Groups can have a shared size

+
+
One
+
Two
+
Three
+
One
Two
Three
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
One
+
+
Two
+
+
+
One
+
+
Two
+
+
+
+
+
One
+
+
Two
+
+
+
One
+
+
Two
+
+
\ No newline at end of file diff --git a/server/documents/elements/input.html.eco b/server/documents/elements/input.html.eco index d4ae70889..6b607b3fb 100755 --- a/server/documents/elements/input.html.eco +++ b/server/documents/elements/input.html.eco @@ -112,8 +112,8 @@ type : 'UI Element'
- -
Add users
+ +
Copy
diff --git a/server/documents/project/contributing.html.eco b/server/documents/project/contributing.html.eco index cd157406f..cf4094bcb 100755 --- a/server/documents/project/contributing.html.eco +++ b/server/documents/project/contributing.html.eco @@ -1,6 +1,6 @@ --- layout : 'default' -css : 'contribute' +css : 'guide' title : 'Contributing' description : 'It takes a village' @@ -14,6 +14,7 @@ type : 'Semantic Project'
Introduction + Bugs Contributing Specification
@@ -42,6 +43,16 @@ type : 'Semantic Project' +

Squashing Bugs

+ +

Please submit any bugs you encounter when using the library to our Github Issues Tracker.

+ +

Be sure to include a set of steps to reproduce the issue and any related information, browser, OS etc. If we can't see the issue then it will make solving things much more difficult.

+ +
When submiting a bug report, please Fork this JSFiddle to create a test-case. It will have Semantic and normalize.css included for you automatically.
+ + Submit a bug report +

Contribute Code

We are looking for a few good coders to help us push out important new features for a release version of Semantic. Here's an overview of current features in development

@@ -49,23 +60,29 @@ type : 'Semantic Project'

CSS Variables

We are working on porting Semantic to using CSS variables to allow for easier theming. We are currently planning on using a CSS Pre-processor to move useful values over to variables. The current plan is to not use mix-ins or pre-processor specific code besides variables, and to add vendor prefixing using Grunt.

- Help code this feature - Share Ideas + Help code this feature + Share Ideas + +

Example Layouts

We are looking to create example layouts with Semantic to help people make sites quicker, and to learn the intracicies of using Semantic UI. The plan is to eventually create a sister site learnsemantic.com which will contain useful features for learning to use Semantic.

- Help code this feature - Share Ideas + Help code this feature + Share Ideas + +

Build Tools

We need to create a customizer for Semantic so user's can choose which components they would like to include and create custom zips with their minified concatenated code.

Most likely this means creating a standalone server that can take API requests for custom builds of semantic and return zip with minified and uncompressed source, or with a little ingenuity in-page javascript which uses JSZIP to do the same

- Help code this feature - Share Ideas + Help code this feature + Share Ideas + +

Test Coverage

@@ -73,27 +90,15 @@ type : 'Semantic Project'

We need help to increase our code coverage by writing Jasmine tests for modules and to write feature specs which can be used to write tests.

- Help code this feature - Share Ideas + Help code this feature + Share Ideas

Contribute Ideas

-

Bugs & Issues

- -

Please submit any bugs you encounter when using the library to our Github Issues Tracker.

- -

Be sure to include a set of steps to reproduce the issue and any related information, browser, OS etc. If we can't see the issue then it will make solving things much more difficult.

- -
When submiting a bug report, please Fork this JSFiddle to create a test-case. It will have Semantic and normalize.css included for you automatically.
- -

Expanding UI

-

Semantic is looking for people to help contribute new core UI components, and suggest extensions for the library.

If you have suggestions for components missing from Semantic which you'd like to see in future versions please add them to our public UI Component board. The current list of upcoming components, and their current development status can be seen on the contributor UI board.

-
Please mark any UI ideas submitted with the label UI Suggestion
- Add an idea @@ -114,7 +119,7 @@ type : 'Semantic Project' Open Issues
- + Next: Developing Semantic diff --git a/server/documents/project/development.html.eco b/server/documents/project/development.html.eco index f9d4fa298..beb2f119a 100755 --- a/server/documents/project/development.html.eco +++ b/server/documents/project/development.html.eco @@ -1,8 +1,8 @@ --- layout : 'default' -css : 'build' +css : 'guide' -title : 'Development' +title : 'Stack Set-up' description : 'A guide to developing locally' type : 'Semantic Project' --- @@ -12,16 +12,16 @@ type : 'Semantic Project'
- Running Locally + Installing Dependencies Fixing Bugs
-

Running Locally

+

Installing Dependencies

It may be useful to run the development docs locally when working on a forked version of semantic, as the docs themselves help in testing out changes to ui components.

-

1) Install Node

+

1. Install Node

Semantic docs are written in DocPad which requires NodeJS.

Make sure npm does not require sudo to operate, this might cause permissions issues.
@@ -31,29 +31,20 @@ type : 'Semantic Project'
  • Installing Node JS without sudo
    • -

    2) Install Dependencies

    +

    2. Fork Semantic

    -
    - // docpad is used to generate static sites like semantic docs - npm install -g docpad -
    + -
    - // eco is used for templating inside documentation - docpad install eco -
    +

    3. Install Dependencies

    +

    Running update inside the local directory will grab all packages in package.json in the root of the project.

    -
    - // grunt is used to automated tasks like concatenating and minifying files - npm install -g grunt-cli +
    + npm update
    -

    3) Fork Semantic

    - - -

    4) Start Your Server

    +

    4. Start Your Server

    docpad run @@ -75,6 +66,23 @@ type : 'Semantic Project'

    The watch task is the default grunt task for Semantic, so you can start it quite simply.

    +

    Running Tests

    +

    Tests will automatically run with grunt watch if you have started karma

    + +
    + karma start + grunt watch +
    + +

    You can also run the test suite manually

    +
    + npm test + // or + grunt build + // or + karma run +
    +

    Packaging Elements

    For convenience there is also a separate grunt command for building minified, packaged, and compressed versions of the library.