chore: documentation: updates readme and contributing markdown files (#…

…677)

README.md

@@ -6,7 +6,7 @@
 
 <div align="center">
 
-[![npm version](https://badge.fury.io/js/@eightfold.ai%2Foctuple.svg)](https://badge.fury.io/js/@eightfold.ai%2Foctuple) ![node](https://img.shields.io/badge/node-16.14.2-brightgreen.svg) [![codecov](https://codecov.io/gh/ychhabra-eightfold/octuple/branch/main/graph/badge.svg?token=K2BV6M1JS5)](https://codecov.io/gh/ychhabra-eightfold/octuple) ![Build](https://github.com/EightfoldAI/octuple/actions/workflows/build.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![npm version](https://badge.fury.io/js/@eightfold.ai%2Foctuple.svg)](https://badge.fury.io/js/@eightfold.ai%2Foctuple) ![node](https://img.shields.io/badge/node-16.14.2-brightgreen.svg) [![codecov](https://codecov.io/gh/EightfoldAI/octuple/branch/main/graph/badge.svg?token=XSAVLS0SVP)](https://codecov.io/gh/EightfoldAI/octuple) ![Build](https://github.com/EightfoldAI/octuple/actions/workflows/build.yml/badge.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ![bundlesize-js-image](https://img.badgesize.io/https:/unpkg.com/browse/@eightfold.ai/octuple/lib/octuple.js?label=octuple.js&compression=gzip)
 ![bundlesize-css-image](https://img.badgesize.io/https:/unpkg.com/browse/@eightfold.ai/octuple/lib/octuple.css?label=octuple.css&compression=gzip)
@@ -18,11 +18,11 @@
 Octuple creates a shared language and visual consistency across different pages and channels.
 It represents a collection of assets, utilities, and React components for building web applications.
 
-- Design (and development) work can be created and replicated quickly and at scale.
+- Design and development work may be created and replicated quickly at scale.
 - Alleviates strain on design resources to focus on larger, more complex problems.
-- Creates a unified language within and between crossfunctional teams.
-- Creates visual consistency across products, channels, and (potentially siloed) departments.
-- Serves as an educational tool and reference for junior-level designers and content contributors.
+- Creates a unified language within and between cross-functional teams.
+- Creates visual consistency across products, channels, and potentially siloed departments.
+- Serves as an educational tool and reference for designers and content contributors.
 
 Visit the Octuple [Storybook site](https://eightfoldai.github.io/octuple.github.io/).
 
@@ -53,7 +53,7 @@ import { PrimaryButton } from '@eightfold.ai/octuple';
 
 export const App = () => (
   <>
-    <PrimaryButton text={'Button'} />
+    <Button text={'Button'} />
   </>
 );
 ```
@@ -84,4 +84,4 @@ Review the guidance for pull requests and the contribution workflow in our [cont
 
 ## License
 
-MIT (c) 2022 Eightfold
+MIT (c) 2023 Eightfold

src/CONTRIBUTING.md

@@ -23,16 +23,16 @@ You will also see any lint errors in the console.
 
 ### `yarn build-storybook`
 
-Builds the Octuple Design System Storybook project to the `dist` folder for deployment.
+Builds the Octuple Design System Storybook project to the `storybook-static` folder for deployment.
 
 ### `yarn test`
 
-Runs the UTs.
+Runs the unit tests.
 
 ### `yarn`
 
-Builds the Octuple Design System Component Library for prod publishing to NPM in to the `lib` folder.
-Should also run the UTs as part of the process.
+Builds the Octuple Design System Component Library for production publishing to NPM in to the `lib` folder.
+Should also run the unit tests as part of the process.
 Your package is ready to be published!
 
 ## Contributing
@@ -145,7 +145,7 @@ When committing changes the Octuple project lints commit messages using the [Con
 An example of such a message:
 
 ```
-fix: ABC-123: button not keyboard accessible
+fix: ABC123: button not keyboard accessible
 
 The button component had a tabIndex of -1 by default
 and therefore it was not keyboard accessible
@@ -163,4 +163,4 @@ To learn more please read:
 
 ## License
 
-MIT (c) 2022 Eightfold
+MIT (c) 2023 Eightfold