@workday/canvas-kit-docs 9.0.13 → 9.0.15

package/dist/es6/lib/docs.js

@@ -104971,7 +104971,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
   {
     "name": "accessibleHide",
     "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/accessibleHide.ts",
-    "description": "A utility to hide content normal users while still making accessible to screenreaders\nSee https://a11y-101.com/development/skip-link",
+    "description": "A utility to visually hide content, while still making accessible to screenreaders\nSee https://a11y-101.com/development/skip-link",
     "declarations": [
       {
         "name": "accessibleHide",

package/dist/mdx/9.0-UPGRADE-GUIDE.mdx

@@ -34,13 +34,50 @@ any questions.
 
 ## Codemod
 
-Please use our [codemod package](https://github.com/Workday/canvas-kit/tree/master/modules/codemod)
-to automatically update your code to work with most of the breaking changes in v9.
+We've provided a [codemod](https://github.com/Workday/canvas-kit/tree/master/modules/codemod) to
+automatically update your code to work with most of the breaking changes in v9. **Breaking changes
+handled by the codemod are marked with 🤖 in the Upgrade Guide.**
+
+A codemod is a script that makes programmatic transformations on your codebase by traversing the
+[AST](https://www.codeshiftcommunity.com/docs/understanding-asts), identifying patterns, and making
+prescribed changes. This greatly decreases opportunities for error and reduces the number of manual
+updates, which allows you to focus on changes that need your attention. **We highly recommend you
+use the codemod for these reasons.**
+
+If you're new to running codemods or if it's been a minute since you've used one, there are a few
+things you'll want to keep in mind.
+
+- Our codemods are meant to be run sequentially. For example, if you're using v7 of Canvas Kit,
+  you'll need to run the v8 codemod before you run v9.
+- The codemod will update your code to be compatible with the specified version, but it will **not**
+  remove outdated dependencies or upgrade dependencies to the latest version. You'll need to upgrade
+  dependencies on your own.
+  - We recommend upgrading dependencies before running the codemod.
+  - Always review your `package.json` files to make sure your dependency versions look correct.
+- The codemod will not handle every breaking change in v9. You will likely need to make some manual
+  changes to be compatible. Use our Upgrade Guide as a checklist.
+- Codemods are not bulletproof.
+  - Conduct a thorough PR and QA review of all changes to ensure no regressions were introduced.
+  - As a safety precaution, we recommend committing the changes from the codemod as a single
+    isolated commit (separate from other changes) so you can roll back more easily if necessary.
+
+We're here to help! Automatic changes to your codebase can feel scary. You can always reach out to
+our team. We'd be very happy to walk you through the process to set you up for success.
+
+### Instructions
+
+The easiest way to run our codemod is to use `npx`.
 
 ```sh
 > npx @workday/canvas-kit-codemod v9 [path]
 ```
 
+Be sure to provide specific directories that need to be updated via the `[path]` argument. This
+decreases the amount of AST the codemod needs to traverse and reduces the chances of the script
+having an error. For example, if your source code lives in `src/`, use `src/` as your `[path]`. Or,
+if you have a monorepo with three packages using Canvas Kit, provide those specific packages as your
+`[path]`.
+
 Alternatively, if you're unable to run the codemod successfully using `npx`, you can install the
 codemod package as a dev dependency, run it with `yarn`, and then remove the package after you're
 finished.
@@ -56,13 +93,6 @@ finished.
 > the codemod, as its resulting formatting (spacing, quotes, etc.) may not match your project
 > conventions.
 
-The codemod will handle _most_ but _not all_ of the breaking changes in v9. **Breaking changes
-handled by the codemod are marked with 🤖 in the Upgrade Guide.**
-
-**Please verify all changes made by the codemod.** As a safety precaution, we recommend committing
-the changes from the codemod as a single isolated commit (separate from other changes) so you can
-roll back more easily if necessary.
-
 ## New Components
 
 ### Table

package/dist/mdx/react/_examples/examples/GlobalHeader.tsx

@@ -16,7 +16,7 @@ import {SearchForm} from '@workday/canvas-kit-labs-react/search-form';
 
 interface HeaderItemProps extends FlexProps {}
 
-export default () => (
+export const Basic = () => (
   <GlobalHeader>
     <GlobalHeader.Item>
       <TertiaryButton aria-label="menu" icon={justifyIcon} />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "9.0.13",
+  "version": "9.0.15",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -44,9 +44,9 @@
   "dependencies": {
     "@emotion/styled": "^11.6.0",
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-labs-react": "^9.0.13",
-    "@workday/canvas-kit-preview-react": "^9.0.13",
-    "@workday/canvas-kit-react": "^9.0.13",
+    "@workday/canvas-kit-labs-react": "^9.0.15",
+    "@workday/canvas-kit-preview-react": "^9.0.15",
+    "@workday/canvas-kit-react": "^9.0.15",
     "@workday/canvas-system-icons-web": "^3.0.0",
     "markdown-to-jsx": "^6.10.3",
     "ts-node": "^10.9.1"
@@ -57,5 +57,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "4.2"
   },
-  "gitHead": "eb7817fde7ef1b670ba24ae16ddee7a5738fc38b"
+  "gitHead": "c44610accaaa4e2cfee98dcfb4db55c9aa1b2d09"
 }