diff --git a/docs/elements/intro.md b/docs/elements/intro.md deleted file mode 100644 index 6d26ea0f54..0000000000 --- a/docs/elements/intro.md +++ /dev/null @@ -1,14 +0,0 @@ -Moving forward, TDS will be replacing most Foundational Element styles with React components. - -Past versions of TDS have distributed a large collection of styling, similar to the approach of libraries such as -Bootstrap or Semantic UI. TDS not only exposed CSS classes that could be applied to many HTML elements, such as -buttons (`.button--primary`) or typography (`.text--medium`), but also styled core HTML elements directly, such a `

-

` -and ``. - -Large amounts of CSS in the global namespace is very difficult to maintain at scale. Naming conventions such as BEM alleviate -some of that pain, but do not eliminate it. In addition, CSS classes only provide look-and-feel, while leaving out other -concerns such as accessibility and interactive behaviors. Finally, CSS classes are tough to evolve, often requiring breaking -changes. - -TELUS digital is aligned on React as the target for creating UIs. Because React makes components a first-class citizen, -the stylesheet-first approach of TDS makes less sense. We can provide a richer TDS experience by embracing React completely. diff --git a/docs/intro/contributions.md b/docs/intro/contributions.md deleted file mode 100644 index 3525ec48a7..0000000000 --- a/docs/intro/contributions.md +++ /dev/null @@ -1,2 +0,0 @@ -Please refer to the [Contribution Guide](https://github.com/telusdigital/tds/blob/master/CONTRIBUTING.md) for more -information about the various ways to contribute to TDS. diff --git a/docs/intro/design-vision.md b/docs/intro/design-vision.md deleted file mode 100644 index 55b55d7561..0000000000 --- a/docs/intro/design-vision.md +++ /dev/null @@ -1,49 +0,0 @@ -Create clear and simple experiences that efficiently satisfy customer needs throughout their journey with TELUS. - -**Create clear and simple designs** - -- All designs should support the brand -- Reduce complexity. Intelligently constrain choice and options -- Be concise - -**Know and respect our customers** - -- Designs and content should be accessible and usable to all, regardless of device, location, demographic, cognitive and physical abilities -- Decisions should be continuously informed by analytics and user research -- Build customer trust. Don’t hide information that customers need and want in order to achieve their goals - -**Support the business** - -- Strike a balance between business goals and user needs -- The design should support business goals, e.g. call offloads, increase L2R -- Work efficiently. Reuse where possible. Consider maintenance - -**Leverage the TELUS design system** - -- Reuse and repurpose -- Use familiar design patterns whenever possible -- Designs need to work within the existing system - -**Measure the impact of your work** - -- Leverage your analytics primes -- Designs should have a measureable hypothesis -- Measure and iterate your designs - -**Design for all screen sizes** - -- Design once to look great on multiple screen sizes e.g. mobile, tablet, desktop -- Use responsive / adaptive design as appropriate -- Understand how design impacts performance. Ensure design is technically feasible - -**Seek the perspective of others** - -- Collaborate with team members, stakeholders, and customers early and often -- Share and evolve your ideas based on feedback -- Explore many different solutions, iterate - -**Consider end-to-end experiences across all channels** - -- Every experience should help customer towards their goal -- No dead ends -- Consider how your designs supports the multichannel experience diff --git a/docs/intro/getting-started.md b/docs/intro/getting-started.md deleted file mode 100644 index 149255e18f..0000000000 --- a/docs/intro/getting-started.md +++ /dev/null @@ -1,24 +0,0 @@ -Developers: - -* The [README](https://github.com/telusdigital/tds/blob/master/README.md) has installation and usage instructions. - -Designers: - -* Must take [Branding 101](https://brand.telus.com/brand/presentations-training) to review and understand brand guidelines. - - -## 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 aesthetic 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] (https://github.com/telusdigital/tds/releases), which can be downloaded in the Github Release page. -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. diff --git a/docs/intro/releases.md b/docs/intro/releases.md deleted file mode 100644 index ac9c70e6ec..0000000000 --- a/docs/intro/releases.md +++ /dev/null @@ -1,13 +0,0 @@ -TDS releases often, and we put every effort into making the upgrade process as smooth as possible. TDS adheres to -[Semantic Versioning](http://semver.org/) so that applications have a predictable way of managing the dependency. - -*Please note: TDS has not yet reached v1.0, meaning it is still in a rapid development phase. While it is in -the 0.y.z versions, minor version upgrades could contain breaking changes. We will try to minimize this as much as possible, -and will document these in the Release Notes and Changelog.* - -Refer the the following links for full information about all TDS releases. - -* [Github Releases](https://github.com/telusdigital/tds/releases): A summary of the important changes for all releases, -including deprecated features, breaking changes, and any upgrade instructions. -* [Github Latest Release](https://github.com/telusdigital/tds/releases/latest): A summary of the latest release. -* [Full Changelog](https://github.com/telusdigital/tds/blob/master/CHANGELOG.md). A comprehensive list of all changes by release. diff --git a/docs/intro/welcome.md b/docs/intro/welcome.md index 726089aff2..1a534b5105 100644 --- a/docs/intro/welcome.md +++ b/docs/intro/welcome.md @@ -1,6 +1,5 @@ Welcome to the TELUS Design System component library. The design system is based on the principles, characteristics, and -aesthetics of the TELUS brand. We embed the brand into React components which are available in this component library. - +aesthetics of the TELUS brand. We embed the brand into React components which are available in this component library. ```jsx noeditor @@ -10,7 +9,7 @@ aesthetics of the TELUS brand. We embed the brand into React components which ar ## New to TDS? -To learn more about the design system, design principles, contribution flow, our support channels, you can get started: +To learn more about the design system, design principles, contribution flow, or our support channels, you can get started: ```jsx noeditor For designers