Skip to content

Commit 8d6d064

Browse files
committed
documentation(ngx-inform): split introduction page into sections for different audiences -- closes #307
1 parent 17e3b97 commit 8d6d064

File tree

1 file changed

+11
-2
lines changed
  • apps/docs/src/app/pages/docs/angular/inform/introduction

1 file changed

+11
-2
lines changed

apps/docs/src/app/pages/docs/angular/inform/introduction/index.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,18 @@
22
keyword: IntroductionPage
33
---
44

5-
`ngx-inform` is a collection of Angular flows related to informing end-users.
5+
## For Organisations
66

7-
`ngx-inform` is a package to help facilitate common user information use-cases such as tooltips, toasts and snackbars.
7+
In modern web applications, effectively communicating with users is crucial. The `@studiohyperdrive/ngx-inform` package provides a comprehensive solution for user notifications and interactions. It helps organisations by:
8+
9+
- **Enhanced User Experience**: Provides clear and consistent ways to communicate with users through tooltips, modals, and notifications
10+
- **Accessibility Compliance**: Ensures all notification components are WCAG compliant, making your application accessible to all users
11+
- **Reduced Development Effort**: Offers ready-to-use, tested components for common notification patterns
12+
- **Consistent Communication**: Standardizes how your application communicates with users across different features
13+
- **Flexible Integration**: Easily adapts to your application's design system and requirements
14+
- **Improved User Guidance**: Helps users understand complex features through tooltips and contextual help
15+
16+
## For Developers
817

918
At its core, `ngx-inform` is build to be WCAG and ARIA compliant, and will throw errors whenever the necessary setup has not been provided to ensure said compliancy.
1019

0 commit comments

Comments
 (0)