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

NotificationMarker docs page #1999

Merged
merged 27 commits into from
Apr 17, 2024
Merged

NotificationMarker docs page #1999

merged 27 commits into from
Apr 17, 2024

Conversation

r100-stack
Copy link
Member

@r100-stack r100-stack commented Apr 15, 2024

Changes

This PR adds a page to the docs site for the NotificationMarker component.

It also makes a few nitpick changes in other docs files to try to have a consistent format across all docs pages.

Testing

N/A

Docs

N/A

@r100-stack r100-stack added the documentation Improvements or additions to documentation label Apr 15, 2024
@r100-stack r100-stack self-assigned this Apr 15, 2024
@r100-stack r100-stack marked this pull request as ready for review April 15, 2024 16:28
@r100-stack r100-stack requested review from a team as code owners April 15, 2024 16:28
@r100-stack r100-stack requested review from mayank99 and Ben-Pusey-Bentley and removed request for a team April 15, 2024 16:28
apps/website/src/content/docs/notificationmarker.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/notificationmarker.mdx Outdated Show resolved Hide resolved

### Status

`NotificationMarker`s can have `primary` (default), `positive`, `warning`, `negative`, or `white` statuses. The `white` status is used on colored backgrounds, such as when using it in the [high visibility](button#high-visibility) or the [call-to-action](button#call-to-action) buttons.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Unrelated) This is making me realize that we should handle the primary vs white statuses by default when used in Button. The user shouldn't need to think about the difference.

apps/website/src/content/docs/notificationmarker.mdx Outdated Show resolved Hide resolved
examples/NotificationMarker.main.jsx Outdated Show resolved Hide resolved
apps/website/src/content/docs/notificationmarker.mdx Outdated Show resolved Hide resolved
apps/website/src/content/docs/anchor.mdx Outdated Show resolved Hide resolved
examples/NotificationMarker.statuses.jsx Outdated Show resolved Hide resolved
@r100-stack r100-stack mentioned this pull request Apr 17, 2024
18 tasks
Co-authored-by: Mayank <[email protected]>
Copy link
Contributor

@mayank99 mayank99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@r100-stack r100-stack merged commit c3ae852 into main Apr 17, 2024
16 checks passed
@r100-stack r100-stack deleted the rohan/notification-marker-docs branch April 17, 2024 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants