Skip to content

Commit

Permalink
Add module responsibilities and critical paths
Browse files Browse the repository at this point in the history
  • Loading branch information
wpscholar authored Apr 17, 2024
1 parent 156e683 commit 0f90aef
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@

A module for managing Newfold in-site notifications.

## Module Responsibilities
- Renders admin notices contextually on specific admin screens or globally unless they have expired or been dismissed.
- Provides an API for fetching notifications, dispatching events that update available notifications, and dismissing notifications.
- Responds in real-time to plugin searches with notifications if triggered.

## Critical Paths
- Notifications with a specific context should only show on the appropriate pages.
- Notifications that have expired should not show at all.
- Notifications that have been dismissed should not show again.
- A plugin search for a specific matching keyword should render a notification in real-time.

## Installation

### 1. Add the Newfold Satis to your `composer.json`.
Expand Down

0 comments on commit 0f90aef

Please sign in to comment.