Skip to content

Commit

Permalink
docs(overview): Add more detail to the overview and getting started s…
Browse files Browse the repository at this point in the history
…ections
  • Loading branch information
ryanoglesby08 committed Jul 25, 2017
1 parent 1d97d09 commit 4056790
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TELUS Design System [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

TDS, the TELUS Design System is a set of living guidelines that communicates our brand promise through our digital experiences.
The TELUS Design System (TDS) is a set of living guidelines that communicates our brand promise through our digital experiences.
It's a holistic platform that integrates documentation, guidelines and design management and that serves as single source for
digital design guidelines, code patterns and UI elements.

Expand Down Expand Up @@ -50,7 +50,7 @@ Now, use TDS components in your application components.

import React from 'react';

import {Card, Spinner} from '@telusdigital/tds';
import { Card, Spinner } from '@telusdigital/tds';

const MyLoadingCard = ({loading, children}) => (
<div>
Expand Down
6 changes: 5 additions & 1 deletion config/styleguide.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@ module.exports = {
sections: [
{
name: 'TELUS Design System',
content: '../docs-new/intro/overview.md',
content: '../docs-new/intro/welcome.md',
sections: [
{
name: 'Getting Started',
content: '../docs-new/intro/getting-started.md'
},
{
name: 'Releases',
content: '../docs-new/intro/releases.md'
Expand Down
20 changes: 20 additions & 0 deletions docs-new/intro/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Developers:

* The [README](https://github.com/telusdigital/tds/blob/master/README.md) has installation and usage instructions.


## How do I use this site?

This is a live showcase, meaning this site is powered by actual TDS components. The interactive examples give you an idea
of both the look-and-feel and the behaviour of the components, while the code snippets and API documentation give developers
the information needed to use the components in an application. Any edits you make to the code snippets will be immediately
reflected in the corresponding example.


## What's included in TDS?

1. Design assets are found in the master Sketch file, which can be downloaded in the Github Release page. (Link coming soon)
2. The core of TDS is a library of React components.
3. The master CSS stylesheet applies a minimal amount of global styles, such as a reset, base font settings, and box sizing.
4. The master CSS stylesheet provides class names for common HTML elements, such as forms, links, typography, and icons. (These will be deprecated soon.)
5. Common Sass variables and mixins are provided.
1 change: 0 additions & 1 deletion docs-new/intro/overview.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs-new/intro/welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Welcome to the TELUS Design System (TDS).

TDS is a set of living guidelines that communicates our brand promise through our digital experiences. It's a holistic
platform that integrates documentation, guidelines and design management and that serves as single source for digital
design guidelines, code patterns and UI elements.

0 comments on commit 4056790

Please sign in to comment.