diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 7dd81b65..4101d40f 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,11 +1,3 @@ -# Motivation +NOTE: This project has been deprecated in favour of [Braid Design System.](https://github.com/seek-oss/braid-design-system) -{{ Why are we proposing an API change? }} - -# Proposed solution with API example(s) - -{{ What does your proposed API look like and why? }} - -# Unresolved questions - -{{ Is there anything else that needs to be discussed? }} +Unless there's a critical production issue, we won't be making further changes to this repo. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 059cd924..4101d40f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,31 +1,3 @@ -** Please provide as much detail as possible, but feel free to remove irrelevant sections ** +NOTE: This project has been deprecated in favour of [Braid Design System.](https://github.com/seek-oss/braid-design-system) -{{ Reason for change }} - -BREAKING CHANGE: - -{{ Description of breaking API change }} - -RFC URL: - -{{ URL of associated RFC for API change }} - -MIGRATION GUIDE: - -Before: - -```js -{{ Old code }} -``` - -After: - -```js -{{ New code }} -``` - -EXAMPLE USAGE: - -```js -{{ Code }} -``` +Unless there's a critical production issue, we won't be making further changes to this repo. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa23cfff..0daf8729 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,9 @@ +## ⚠️ NOTE: This project has been deprecated in favour of [Braid Design System.](https://github.com/seek-oss/braid-design-system) + +Unless there's a critical production issue, we won't be making further changes to this repo. + +--- + # Contributing to seek-style-guide ⚠️ 🌏 👀 First and foremost, remember that this repo is **open source**. diff --git a/README.md b/README.md index 460bb127..fa243354 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +## ⚠️ NOTE: This project has been deprecated in favour of [Braid Design System.](https://github.com/seek-oss/braid-design-system) + +--- + [![Build Status](https://img.shields.io/travis/seek-oss/seek-style-guide/master.svg?style=flat-square)](http://travis-ci.org/seek-oss/seek-style-guide) [![npm](https://img.shields.io/npm/v/seek-style-guide.svg?style=flat-square)](https://www.npmjs.com/package/seek-style-guide) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/) [![Styled with Prettier](https://img.shields.io/badge/styled%20with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) # seek-style-guide @@ -50,28 +54,6 @@ export default class App extends Component { `StyleGuideProvider`'s props are used to set the page head properties using [Helmet](https://github.com/nfl/react-helmet). -### Applying the Standard Header and Footer - -The standard header and footer are provided as React components: - -```js -import { Header, Footer } from 'seek-style-guide/react'; -``` - -The `
` component accepts the following props: - -- **locale:** `'AU'` (default) or `'NZ'` -- **authenticated:** `null/undefined` (default, authentication pending), `true` or `false` -- **userName:** User's display name, when authenticated -- **activeTab:** Text of the active tab, e.g. `'Job Search'` -- **divider:** `true` (default, renders a blue divider below the navigation tabs) or `false` -- **linkRenderer:** Function to allow custom rendering of links. The default implementation simply renders a standard link, spreading all props: `props => ` - -The `