Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Coach Mark: Documentation fixes #639

Merged
merged 6 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions .changeset/famous-gorillas-poke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@ithaka/pharos-site': patch
---

Fix coach mark documentation issues
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center" valign="top" width="14.28%"><a href="http://brentswisher.com/"><img src="https://avatars.githubusercontent.com/u/6653970?v=4?s=100" width="100px;" alt="Brent Swisher"/><br /><sub><b>Brent Swisher</b></sub></a><br /><a href="https://github.com/ithaka/pharos/issues?q=author%3Abrentswisher" title="Bug reports">🐛</a> <a href="https://github.com/ithaka/pharos/commits?author=brentswisher" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/henryclong"><img src="https://avatars.githubusercontent.com/u/52258386?v=4?s=100" width="100px;" alt="Henry Long"/><br /><sub><b>Henry Long</b></sub></a><br /><a href="https://github.com/ithaka/pharos/commits?author=henryclong" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://matharris.dev/"><img src="https://avatars.githubusercontent.com/u/6874453?v=4?s=100" width="100px;" alt="Mat Harris"/><br /><sub><b>Mat Harris</b></sub></a><br /><a href="#a11y-sirrah-tam" title="Accessibility">️️️️♿️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/david-corneail"><img src="https://avatars.githubusercontent.com/u/104939119?v=4?s=100" width="100px;" alt="david-corneail"/><br /><sub><b>david-corneail</b></sub></a><br /><a href="#design-david-corneail" title="Design">🎨</a> <a href="https://github.com/ithaka/pharos/commits?author=david-corneail" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
Expand Down
1 change: 1 addition & 0 deletions packages/pharos-site/src/components/Sidenav.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ const Sidenav: FC = () => {
'Button',
'Breadcrumb',
'Checkbox',
'Coach Mark',
'Combobox',
'Dropdown menu',
'Dropdown menu nav',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 3 additions & 4 deletions packages/pharos-site/static/guidelines/coach-mark.docs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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"
></PageSection>

## Examples
Expand All @@ -25,12 +25,12 @@ import BestPractices from '@components/statics/BestPractices.tsx';
</div>
<PharosCoachMark
id="example-coachmark"
hide="false"
hide={false}
side="bottom"
alignment="start"
header="Coach Mark"
delay="short"
variant="light"
variant="dark"
>
This is an example Coach Mark
</PharosCoachMark>
Expand Down Expand Up @@ -91,7 +91,6 @@ import BestPractices from '@components/statics/BestPractices.tsx';
Use coach marks to focus attention to important functionality and feedback in context
</li>
<li>Display coach marks on a page once per session</li>
<li>Checkboxes should always include a label</li>
<li>
Consider a coach mark to promote new features, functionality, or other changes to layout
and patterns that may disorient the user
Expand Down