docs(guide): adjust table of contents

- remove custom hash anchors - make links match destination page h1 - apply some information architecture to the table of contents
telus · Jan 26, 2018 · 416aa27 · 416aa27
1 parent 85b2473
commit 416aa27
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 22 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1 +1 @@
-* [Contributing guidelines](/guide/contributing/contributing.md)
+View [Contributing to TDS](https://github.com/telusdigital/tds/blob/master/guide/contributing/contributing.md) in our guide.
diff --git a/guide/README.md b/guide/README.md
@@ -1,14 +1,16 @@
+# TDS guidelines
+
+These guidelines are for the usage, contribution, principles, and support for the TELUS design system. To view the documentation for components, see the [component catalogue](http://tds.telus.com).
 ## Table of Contents
 
-* [Getting Started](getting-started/getting-started.md)
-  * [Designers](getting-started/designers.md)
-  * [Developers](getting-started/developers.md)
-* [Components](http://tds.telus.com)
-* [Contributing](contributing/contributing.md)
+* [Getting started](getting-started/getting-started.md)
+  * [Designer guide](getting-started/designers.md)
+  * [Developer guide](getting-started/developers.md)
+* [Contributing to TDS](contributing/contributing.md)
   * [Designer guide](contributing/designer-guide.md)
   * [Developer guide](contributing/developer-guide.md)
-  * [Codebase overview](contributing/codebase-overview.md)
-* [Roadmap](roadmap.md)
+  * [Codebase overview and standards](contributing/codebase-overview.md)
+* [The TELUS design platform roadmap](roadmap.md)
 
 #### Design principles &amp; guidelines
 

diff --git a/guide/contributing/designer-guide.md b/guide/contributing/designer-guide.md
@@ -1,4 +1,4 @@
-# TDS Design Contribution
+# Contributing to TDS - designer guide
 
 Guidelines & Standards
 

diff --git a/guide/contributing/developer-guide.md b/guide/contributing/developer-guide.md
@@ -1,4 +1,4 @@
-# Developer guide
+# Contributing to TDS - developer guide
 
 ## Prerequisites
 

diff --git a/guide/contributing/standards.md b/guide/contributing/standards.md
@@ -1,8 +1,8 @@
-# Development Standards at TDS
+# Codebase overview and standards
 
 When it comes to writing code and documentation we have internal standards that help keep everything consistent and highly maintainable.
 
-## Documentation standards {#docs}
+## Documentation standards
 
 [Documenting components](#documenting-components)
 

diff --git a/guide/getting-started/designers.md b/guide/getting-started/designers.md
@@ -1,6 +1,4 @@
-# TDS Getting Started
-
-A Guide for Designers
+# TDS getting started - designer guide
 
 ## Tools
 

diff --git a/guide/getting-started/developers.md b/guide/getting-started/developers.md
@@ -1,6 +1,4 @@
-# TDS Getting Started
-
-A Guide for Developers
+# TDS getting started - developer guide
 
 As a developer, your primary interaction point with TDS is through React components. Though the components are currently distributed in a single bundle, you should conceptualize them as independent, composable components.
 
@@ -65,7 +63,7 @@ Import the TDS stylesheet into the main entry point of your application. It cont
 
 You will not use these styles directly. Webpack will bundle the TDS styles with your application-specific styles, and they will be consumed by the TDS components.
 
-See the FAQ for [more info about the specific global styles that are applied](faq.md#global-styles).
+See the FAQ for [more info about the specific global styles that are applied](faq.md#what-global-styles-does-tds-set-on-the-page).
 
 ```js
 // index.js

diff --git a/guide/getting-started/faq.md b/guide/getting-started/faq.md
@@ -1,4 +1,4 @@
-# FAQ
+# FAQs
 
 ## A TDS component does not do what I need. What do I do?
 
@@ -38,7 +38,7 @@ not modify built-in APIs) if it uses a browser API that is not widely supported
 recommend the use of the Set object in [polyfill.io](https://polyfill.io/v2/docs/) (see 
 [starter kit example][starter-kit-polyfill]) for rendering the ExpandCollapse component in older browsers.
 
-## What global styles does TDS set on the page? {#global-styles}
+## What global styles does TDS set on the page?
 
 The majority of TDS styles are component styles that have been generated by our build tooling to prevent conflicts with application styles. However, there are a small amount of page level styles to establish a common baseline.
 

diff --git a/guide/getting-started/getting-started.md b/guide/getting-started/getting-started.md
@@ -1,4 +1,4 @@
-# Getting started with TDS
+# Getting started
 
 TDS includes resources for designers and developers that are needed to build consistent user interfaces on the TELUS Digital Platform. TDS enables designers and developers to focus on solving unique application challenges, rather than having to reinvent standard interface elements.