Skip to content

Commit d651070

Browse files
authored
Techdocs content revisions (#608)
* remove unused page from nav * content revisions
1 parent 46fa3bb commit d651070

4 files changed

Lines changed: 14 additions & 15 deletions

File tree

docs/configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The design tokens library includes the full [design tokens schema](https://www2.
99

1010
Import your preferred format in order to use tokens to style your UI elements.
1111

12-
The library also includes a prefixed implementation, which prepends each variable with a `bcds` namespace. This can help prevent naming collisions, especially if you're already using variables.
12+
The library also includes an alternative `prefixed` implementation, which prefixes each variable with a `bcds` namespace. This can help prevent naming collisions, especially if you're already using variables.
1313

1414
## Components
1515

@@ -48,3 +48,5 @@ import {
4848
Each component has an extensive set of props that you can use to configure their appearance, behaviour and interactions with other components.
4949

5050
Consult the [component documentation in Storybook](https://designsystem.gov.bc.ca/react-components/) to learn more about a component's structure and supported props.
51+
52+
If you need a specific component not included in the design system, [React Aria Components](https://react-aria.adobe.com) provides an extensive library of unstyled components. You can mix-and-match components from both libraries as needed, to leverage common APIs and ensure consistent interactions and behaviours.

docs/getting-started.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,7 @@ Both packages use the BC Sans typeface, and install [@bcgov/bc-sans](https://www
2323

2424
To install the packages, run:
2525

26-
```
27-
npm i @bcgov/design-tokens
28-
npm i @bcgov/design-system-react-components
29-
```
26+
`npm i @bcgov/design-tokens`
27+
`npm i @bcgov/design-system-react-components`
3028

31-
Both packages follow semantic versioning. Minor and patch versions will not include breaking changes. At this time, we nonetheless recommend pinning to a specific version in your `package.json` and installing updates manually (after reviewing the release notes carefully.)
29+
Both packages follow semantic versioning. Minor and patch versions will not include breaking changes. At this time, we nonetheless recommend pinning to a specific version in your `package.json` and installing updates manually, after carefully reviewing the release notes.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If you need help, you can:
5252

5353
All components are fully documented. Go to [gov.bc.ca/designsystem](https://gov.bc.ca/designsystem) to browse foundational and component-level documentation.
5454

55-
Rendered examples and detailed technical documentation for each component are also [published in a Storybook](https://designsystem.gov.bc.ca/react-components/).
55+
Interactive examples and detailed technical documentation for each component are also [published in a Storybook](https://designsystem.gov.bc.ca/react-components/).
5656

5757
## Cost
5858

mkdocs.yml

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@ docs_dir: "docs"
44
repo_url: "https://github.com/bcgov/design-system"
55
edit_uri: edit/main/docs
66
nav:
7-
- Introduction: index.md
8-
- Getting started: getting-started.md
9-
- Configuration: configuration.md
10-
- Tips and tricks: tips-and-tricks.md
11-
- About us: about-us.md
7+
- Introduction: index.md
8+
- Getting started: getting-started.md
9+
- Configuration: configuration.md
10+
- About us: about-us.md
1211
plugins:
13-
- techdocs-core
14-
- git-revision-date-localized
12+
- techdocs-core
13+
- git-revision-date-localized
1514
markdown_extensions:
16-
- md_in_html
15+
- md_in_html

0 commit comments

Comments
 (0)