Browse Source

Updating docs for contributing, fixing various bugs on pages

pull/291/head
jlukic 11 years ago
parent
commit
38e7783bfc
8 changed files with 79 additions and 62 deletions
  1. 2
      server/documents/collections/form.html.eco
  2. 2
      server/documents/elements/button.html.eco
  3. 8
      server/documents/introduction/definitions.html.eco
  4. 6
      server/documents/modules/dropdown.html.eco
  5. 15
      server/documents/modules/shape.html.eco
  6. 87
      server/documents/project/contributing.html.eco
  7. 15
      server/documents/project/development.html.eco
  8. 6
      server/files/stylesheets/semantic.css

2
server/documents/collections/form.html.eco

@ -129,8 +129,8 @@ type : 'UI Collection'
</div>
<div class="ui selection dropdown">
<input type="hidden" name="gender">
<i class="dropdown icon"></i>
<div class="default text">Gender</div>
<i class="dropdown icon"></i>
<div class="menu">
<div class="item" data-value="male">Male</div>
<div class="item" data-value="female">Female</div>

2
server/documents/elements/button.html.eco

@ -207,6 +207,8 @@ type : 'UI Element'
<a class="ui green button">Green BUtton</a>
<a class="ui red button">Red Button</a>
<a class="ui blue button">Blue Button</a>
</div>
<div class="another example">
<a class="ui purple button">Purple Button</a>
<a class="ui teal button">Teal Button</a>
<a class="ui orange button">Orange Button</a>

8
server/documents/introduction/definitions.html.eco

@ -91,7 +91,7 @@ type : 'UI Introduction'
<div class="ui divided relaxed list">
<div class="item">
<div class="header">Content</div>
<div class="description">Content elements which can exist inside of the UI collection</div>
<div class="description">A collection can define elements which might be found inside</div>
</div>
<div class="item">
<div class="header">States</div>
@ -115,7 +115,7 @@ type : 'UI Introduction'
<div class="ui divided relaxed list">
<div class="item">
<div class="header">Content</div>
<div class="description">Content elements which can exist inside of the UI view</div>
<div class="description">A view may define elements which can exist inside of the view</div>
</div>
<div class="item">
<div class="header">States</div>
@ -139,11 +139,11 @@ type : 'UI Introduction'
<div class="ui divided relaxed list">
<div class="item">
<div class="header">Behavior</div>
<div class="description">A set of behaviors which can be invoked programatically</div>
<div class="description">A module will define a set of <a href="/module.html#/behavior">behaviors</a> which can be used as an API</div>
</div>
<div class="item">
<div class="header">Settings</div>
<div class="description">A settings object which can alter the default behavior when instantiating a module</div>
<div class="description">A <a href="/module.html#/settings">settings object</a> which can alter the default behavior when instantiating a module</div>
</div>
<div class="item">
<div class="header">Examples</div>

6
server/documents/modules/dropdown.html.eco

@ -132,7 +132,7 @@ type : 'UI Module'
</div>
</div>
<div class="another button example">
<div class="ui teal right pointing dropdown icon button">
<div class="ui right pointing dropdown icon button">
<i class="settings icon"></i>
<div class="menu">
<div class="item"><i class="edit icon"></i>Edit</div>
@ -140,7 +140,7 @@ type : 'UI Module'
<div class="item"><i class="hide icon"></i>Hide</div>
</div>
</div>
<div class="ui green left pointing dropdown icon button">
<div class="ui left pointing dropdown icon button">
<i class="settings icon"></i>
<div class="menu">
<div class="item"><i class="edit icon"></i>Edit</div>
@ -377,7 +377,7 @@ type : 'UI Module'
<div class="dropdown example">
<h3 class="ui header">Button Group</h3>
<p>A <a href="/elements/button.html">button group</a> can be formatted to show additional content as a dropdown</p>
<div class="ui red icon buttons">
<div class="ui icon buttons">
<div class="ui top left pointing dropdown button">
<i class="user icon"></i>
<div class="menu">

15
server/documents/modules/shape.html.eco

@ -8,6 +8,7 @@ type : 'UI Module'
---
<script src="/javascript/shape.js"></script>
<link rel="stylesheet" type="text/css" class="ui" href="/stylesheets/shape.css">
<%- @partial('header', { tabs: 'module' }) %>
@ -147,6 +148,14 @@ type : 'UI Module'
<div class="no example">
<h3 class="ui header">Shape Types</h3>
<p>Shapes do not have to be regular or have its sides match up in length and width to animate correctly.</p>
<h3 class="ui header">Shape</h3>
<div class="ui type buttons">
<div class="active ui button" data-shape="rectangle">Rectangle</div>
<div class="ui button" data-shape="square">Square</div>
<div class="ui button" data-shape="irregular">Irregular</div>
</div>
<div class="ui divider"></div>
<div class="demo rectangle ui shape">
<div class="sides">
<div class="active jira side">
@ -160,12 +169,6 @@ type : 'UI Module'
</div>
</div>
</div>
<h3 class="ui header">Shape</h3>
<div class="ui type buttons">
<div class="active ui button" data-shape="rectangle">Rectangle</div>
<div class="ui button" data-shape="square">Square</div>
<div class="ui button" data-shape="irregular">Irregular</div>
</div>
<div class="ui divider"></div>
<div class="ui icon direction buttons">

87
server/documents/project/contributing.html.eco

@ -21,10 +21,7 @@ type : 'Semantic Project'
<h2 class="ui dividing header">Introduction</h2>
<p>There are a variety of ways to contribute to the development of Semantic. We are a very new project and are looking for an enthusiastic and like-minded group of core contributors. We use the lovely free project management software <a href="https://trello.com/jack148/recommend">Trello</a> for keeping track of project issues and updates.</p>
<p>Some Trello boards are open publicly, others are limited to contributors. Anyone can share ideas for the direction of the project using our public boards.</p>
<p>If you are looking to be added to contributor board on Semantic and are active in development, please reach out to me by e-mail <a href="mailto:jack@myfav.es">jack@myfav.es</a></p>
<p>There are a variety of ways to contribute to the development of Semantic. We are a very new project and are looking for an enthusiastic and like-minded group of core contributors.
<h3 class="ui header">Publicity</h3>
@ -45,57 +42,79 @@ type : 'Semantic Project'
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
<h2 class="ui dividing header">Making Semantic Better</h2>
<h2 class="ui dividing header">Contribute Code</h2>
<h3 class="ui dividing header">Bugs & Issues</h3>
<p>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</p>
<p>Please submit any bugs you encounter when using the library to our <a href="https://github.com/jlukic/Semantic-UI/issues?state=open">Github Issues Tracker</a>.</p>
<h3 class="ui header">CSS Variables</h3>
<p>When submiting a bug report, please 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.</p>
<p>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 <b>not use mix-ins or pre-processor specific code</b> besides variables, and to add vendor prefixing using Grunt.</p>
<a class="ui green labeled icon button" href="mailto:jacklukic@gmail.com?Subject=I%20would%20love%20to%20work%20on%20%3Cinsert%20feature%20name%3E&Body=Hey%2C%20I%20just%20wanted%20to%20introduce%20myself%0A%0A%3CHere%27s%20a%20link%20to%20info%20about%20me%20or%20my%20github%3E%0A%0A%3CHere%27s%20a%20bit%20about%20what%20i%20need%20to%20help%20contribute%3E%0A%0A%3CHere%27s%20how%20i%20think%20i%27ll%20get%20started%20on%20that%20feature%3E"><i class="doctor icon"></i> Help code this feature</a>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/issues/216">Share Ideas</a>
<h3 class="ui header">Style Guide</h3>
<p>Contributors should read over the coding guidelines for the project. Most importantly, the guide for language, as it is one of the most important parts about Semantic UI.</p>
<a class="ui secondary button" href="/guide/styleguide.html">Language</a>
<a class="ui button" href="/guide/cssguide.html">CSS</a>
<a class="ui button" href="/guide/javascriptguide.html">Javascript</a>
<h3 class="ui header">Example Layouts</h3>
<p>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 <b>learnsemantic.com</b> which will contain useful features for learning to use Semantic.</p>
<a class="ui green labeled icon button" href="mailto:jacklukic@gmail.com?Subject=I%20would%20love%20to%20work%20on%20%3Cinsert%20feature%20name%3E&Body=Hey%2C%20I%20just%20wanted%20to%20introduce%20myself%0A%0A%3CHere%27s%20a%20link%20to%20info%20about%20me%20or%20my%20github%3E%0A%0A%3CHere%27s%20a%20bit%20about%20what%20i%20need%20to%20help%20contribute%3E%0A%0A%3CHere%27s%20how%20i%20think%20i%27ll%20get%20started%20on%20that%20feature%3E"><i class="doctor icon"></i> Help code this feature</a>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/issues/206">Share Ideas</a>
<h3 class="ui header">Build Tools</h3>
<p>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.</p>
<p>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</p>
<a class="ui green labeled icon button" href="mailto:jacklukic@gmail.com?Subject=I%20would%20love%20to%20work%20on%20%3Cinsert%20feature%20name%3E&Body=Hey%2C%20I%20just%20wanted%20to%20introduce%20myself%0A%0A%3CHere%27s%20a%20link%20to%20info%20about%20me%20or%20my%20github%3E%0A%0A%3CHere%27s%20a%20bit%20about%20what%20i%20need%20to%20help%20contribute%3E%0A%0A%3CHere%27s%20how%20i%20think%20i%27ll%20get%20started%20on%20that%20feature%3E"><i class="doctor icon"></i> Help code this feature</a>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/issues/189">Share Ideas</a>
<h3 class="ui header">Test Coverage</h3>
<p>Semantic uses <a href="">Jasmine</a> with <a href="http://karma-runner.github.io/0.10/index.html" target="_blank">Karma Test Runner</a> and <a href="https://travis-ci.org/jlukic/Semantic-UI" target="_blank">Travis CI</a> to write unit tests for our UI modules.</p>
<h3 class="ui dividing header">Pull Requests</h3>
<p>We need help to increase our code coverage by writing Jasmine tests for <a href="/module.html">modules</a> and to write feature specs which can be used to write tests.</p>
<p>Anyone can jump on the issues board and grab off bugs to fix. This is probably the best way to become a contributor to Semantic. Be sure to adhere to the style guides when submitting code.</p>
<a class="ui green labeled icon button" href="mailto:jacklukic@gmail.com?Subject=I%20would%20love%20to%20work%20on%20%3Cinsert%20feature%20name%3E&Body=Hey%2C%20I%20just%20wanted%20to%20introduce%20myself%0A%0A%3CHere%27s%20a%20link%20to%20info%20about%20me%20or%20my%20github%3E%0A%0A%3CHere%27s%20a%20bit%20about%20what%20i%20need%20to%20help%20contribute%3E%0A%0A%3CHere%27s%20how%20i%20think%20i%27ll%20get%20started%20on%20that%20feature%3E"><i class="doctor icon"></i> Help code this feature</a>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/issues/244">Share Ideas</a>
<ul class="ui list">
<li><a href="https://github.com/jlukic/Semantic-UI/compare/">Create a Pull Request</a></li>
<li><a href="https://github.com/jlukic/Semantic-UI/issues?state=open">View Open Issues</a></li>
</ul>
<h2 class="ui dividing header">Contribute Ideas</h2>
<h3 class="ui header">Bugs & Issues</h3>
<h3 class="ui dividing header">Expanding UI</h3>
<p>Please submit any bugs you encounter when using the library to our <a href="https://github.com/jlukic/Semantic-UI/issues?state=open">Github Issues Tracker</a>.</p>
<p>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.</p>
<div class="ui warning message">When submiting a bug report, please <a href="http://jsfiddle.net/jlukic/Vbr9d/1/">Fork this JSFiddle</a> to create a test-case. It will have Semantic and normalize.css included for you automatically.</div>
<h3 class="ui header">Expanding UI</h3>
<p>Semantic is looking for people to help contribute new core UI components, and suggest extensions for the library.</p>
<p>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.</p>
<h4 class="ui header">Visit UI Development Boards</h4>
<div class="ui buttons">
<a class="ui button" href="https://trello.com/b/Q8uTLy2T">Public</a>
<a class="ui button" href="https://trello.com/b/yVsh5Rds">Contributor</a>
</div>
<div class="ui message">Please mark any UI ideas submitted with the label <span class="ui black label">UI Suggestion</span class="ui black label"></div>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/issues/new"><i class="lightbulb icon"></i> Add an idea</a>
<h2 class="ui diving header">Specification Development</h2>
<h2 class="ui dividing header">Learning More</h2>
<p>We're looking currently for ideas on the best way to expand Semantic to include both core library and third party components. This requires creating a component specification which can be used by anyone to create ui components, and a package management system (website or command line) for authors to distribute them.</p>
<h3 class="ui header">Style Guide</h3>
<p>Contributors may find it useful to read over the coding guidelines for the project. Most importantly, the guide for language, as it is one of the most important parts about Semantic UI.</p>
<a class="ui button" href="/guide/styleguide.html">Language</a>
<a class="ui button" href="/guide/cssguide.html">CSS</a>
<a class="ui button" href="/guide/javascriptguide.html">Javascript</a>
<p>These features are very important for the healthy growth of the Semantic ecosystem, and to expand the number of components available to users.</p>
<h3 class="ui header">Pull Requests</h3>
<h4 class="ui header">Visit Community Development Boards</h4>
<div class="ui buttons">
<a class="ui button" href="https://trello.com/b/FZvMsVIM">Public</a>
<a class="ui button" href="https://trello.com/b/eOoZwNBQ">Contributor</a>
</div>
<p>If you see an issue, feel free to open a pull request.</p>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/compare/">Create a Pull Request</a>
<a class="ui button" href="https://github.com/jlukic/Semantic-UI/issues?state=open">Open Issues</a>
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/project/development.html">
<a class="ui large right floated labeled teal icon button" href="/project/development.html">
Next: Developing Semantic
<i class="right arrow icon"></i>
</a>

15
server/documents/project/development.html.eco

@ -14,7 +14,6 @@ type : 'Semantic Project'
<div class="ui vertical pointing secondary menu">
<a class="active item">Running Locally</a>
<a class="item">Fixing Bugs</a>
<a class="item">The Future</a>
</div>
</div>
@ -83,23 +82,11 @@ type : 'Semantic Project'
grunt build
</div>
<h2 class="ui dividing header">The Future</h2>
<h3 class="ui header">UI Dev Kits</h3>
<p>We are working to create development kits for writing and distributing third party UI definitions. These, are planned to land after our 1.0 release and allow other developers to contribute ui components or reskins of existing components.</p>
<p>For more information on the development of the UI specification for third party components, please visit our community discussion boards on Trello</p>
<h4 class="ui header">Development Boards</h4>
<div class="ui buttons">
<a class="ui button" href="https://trello.com/b/FZvMsVIM">Public</a>
<a class="ui button" href="https://trello.com/b/eOoZwNBQ">Contributor</a>
</div>
<h3 class="ui header"></h3>
<div class="ui divider"></div>
<a class="ui large right labeled teal icon button" href="/introduction.html">
<a class="ui large right floated labeled teal icon button" href="/introduction.html">
Next: Library Introduction
<i class="right arrow icon"></i>
</a>

6
server/files/stylesheets/semantic.css

@ -770,6 +770,12 @@ body.guide .main.container > * {
#example.overview h2.ui.header {
margin-bottom: 0em;
}
/*
#example .ui.header ~ .ui.message a,
#example .ui.header ~ p a {
font-weight: bold;
}
*/
#example.overview .example {
margin: 0em;
min-height: 0px !important;

Loading…
Cancel
Save