diff --git a/.all-contributorsrc b/.all-contributorsrc index 86b61b399..7bed3efdd 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -326,6 +326,16 @@ "contributions": [ "a11y" ] + }, + { + "login": "david-corneail", + "name": "david-corneail", + "avatar_url": "https://avatars.githubusercontent.com/u/104939119?v=4", + "profile": "https://github.com/david-corneail", + "contributions": [ + "design", + "doc" + ] } ], "contributorsPerLine": 7 diff --git a/.changeset/famous-gorillas-poke.md b/.changeset/famous-gorillas-poke.md new file mode 100644 index 000000000..1961cfc2b --- /dev/null +++ b/.changeset/famous-gorillas-poke.md @@ -0,0 +1,5 @@ +--- +'@ithaka/pharos-site': patch +--- + +Fix coach mark documentation issues diff --git a/README.md b/README.md index 621e2a1e6..4a3726cf4 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d Brent Swisher
Brent Swisher

🐛 💻 Henry Long
Henry Long

💻 Mat Harris
Mat Harris

️️️️♿️ + david-corneail
david-corneail

🎨 📖 diff --git a/packages/pharos-site/src/components/Sidenav.tsx b/packages/pharos-site/src/components/Sidenav.tsx index c2a8b6dfe..a3795f0a8 100644 --- a/packages/pharos-site/src/components/Sidenav.tsx +++ b/packages/pharos-site/src/components/Sidenav.tsx @@ -117,6 +117,7 @@ const Sidenav: FC = () => { 'Button', 'Breadcrumb', 'Checkbox', + 'Coach Mark', 'Combobox', 'Dropdown menu', 'Dropdown menu nav', diff --git a/packages/pharos-site/src/pages/components/component-status/status.json b/packages/pharos-site/src/pages/components/component-status/status.json index 029a8fecf..361fb8782 100644 --- a/packages/pharos-site/src/pages/components/component-status/status.json +++ b/packages/pharos-site/src/pages/components/component-status/status.json @@ -155,6 +155,32 @@ "description": "" } }, + "coach-mark": { + "design": { + "status": "released", + "description": "" + }, + "development": { + "status": "released", + "description": "" + }, + "tests": { + "status": "released", + "description": "" + }, + "documentation": { + "status": "released", + "description": "" + }, + "released": { + "status": "13.0.0", + "description": "" + }, + "updated": { + "status": "13.0.0", + "description": "" + } + }, "combobox": { "design": { "status": "released", diff --git a/packages/pharos-site/static/guidelines/coach-mark.docs.mdx b/packages/pharos-site/static/guidelines/coach-mark.docs.mdx index d25708281..5d7f7dbc7 100644 --- a/packages/pharos-site/static/guidelines/coach-mark.docs.mdx +++ b/packages/pharos-site/static/guidelines/coach-mark.docs.mdx @@ -5,7 +5,7 @@ import BestPractices from '@components/statics/BestPractices.tsx'; title="Coach Mark" description="Coach marks highlight new or unique features, direct users in the right direction, or guide users during onboarding." isHeader - storyBookType="forms" + storyBookType="components" > ## Examples @@ -25,12 +25,12 @@ import BestPractices from '@components/statics/BestPractices.tsx'; This is an example Coach Mark @@ -91,7 +91,6 @@ import BestPractices from '@components/statics/BestPractices.tsx'; Use coach marks to focus attention to important functionality and feedback in context
  • Display coach marks on a page once per session
  • -
  • Checkboxes should always include a label
  • Consider a coach mark to promote new features, functionality, or other changes to layout and patterns that may disorient the user