Skip to content

Commit 783b938

Browse files
committed
add screenshots into intro and user guide pages
1 parent 0975347 commit 783b938

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

docs/user-docs/docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ An **eligibility screener** is a web-based form that:
1616
2. Evaluates that information against defined eligibility rules
1717
3. Displays eligibility results based on the evaluation
1818

19+
![An eligibility form for assistance programs. The form asks if the user lives in Philly, their birthday, if they own their house, and which benefits they are enrolled in. The results show that the user is eligible for Food Assistance because they live in Philadelphia, are over 18, and are enrolled in Food Assistance. However, they are ineligible for Heating Assistance because although they are enrolled in Food Assistance and over 18, they do not own their house.](images/example-screener.png)
20+
1921
Each screener has two primary components that work together:
2022

2123
### 2.1 User Interface
@@ -28,8 +30,6 @@ The eligibility logic defines how user inputs are evaluated. It applies the bene
2830

2931
BDT allows you to configure both the user interface form and back-end eligibility logic in low-code editors and then publishes them together as a single, accessible URL.
3032

31-
> TODO: Insert example screenshot of a published screener
32-
3333
---
3434

3535
## 3. Key Concepts

docs/user-docs/docs/user-guide.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This guide walks through how to create, configure, test, and publish an eligibil
88

99
After signing in, you will land on the **Screeners** view. This page displays all of your existing screener projects and serves as your starting point for creating and managing screeners.
1010

11+
![Benefit Decision Toolkit homepage featuring a welcome message and an option to create a new screener. The page includes a navigation bar with options for 'Screeners' and 'Eligibility checks'. There is also a card labeled 'Food & Heating Assistance' with a menu option indicated by three dots.](images/screener-dashboard.png)
12+
1113
From here, you can:
1214

1315
- View all of your existing screeners
@@ -20,8 +22,6 @@ Select **Create New Screener** and provide a name for your screener. The name sh
2022

2123
After the screener is created, you are automatically taken to the **Screener Dashboard**.
2224

23-
> TODO: Add image of Screeners view
24-
2525
---
2626

2727
## 2. The Screener Dashboard
@@ -37,8 +37,6 @@ At the top of the page, the navigation bar contains four tabs representing the m
3737

3838
Work through these tabs in order when building a screener for the first time. The eligibility logic you define in **Manage Benefits** informs what inputs the **Form Editor** needs to collect, and both must be complete before **Preview** and **Publish** are meaningful.
3939

40-
> TODO: Add image of Screener Dashboard
41-
4240
---
4341

4442
## 3. Defining Eligibility Logic (Manage Benefits)
@@ -58,20 +56,22 @@ A single screener can evaluate eligibility for one or multiple benefits. Each be
5856

5957
The **Manage Benefits** tab displays all benefits configured for your screener as a list of cards.
6058

59+
![Manage Benefits page of the Benefit Decision Toolkit. The page allows users to define and organize benefits available in their screener, with each benefit having associated eligibility checks. There is a 'Create New Benefit' button at the top. Two benefits are listed: Food Assistance, described as 'Help with affording groceries,' and Heating Assistance, described as 'Discount on PGW bill.' Each benefit has 'Edit' and 'Remove' buttons for managing the entries. The navigation bar at the top includes links to Food & Heating Assistance, Manage Benefits, Form Editor, Preview, and Publish.](images/manage-benefits.png)
60+
6161
From this view, you can:
6262

6363
- **Create** a new benefit by selecting **Create New Benefit** and providing a name and description
6464
- **Edit** a benefit by selecting **Edit** on its card, which opens the **Configure Benefit** page
6565
- **Remove** a benefit by selecting **Remove** on its card
6666

67-
> TODO: Add image of Manage Benefits view
68-
6967
---
7068

7169
## 4. Configuring a Benefit
7270

7371
The **Configure Benefit** page is where you define the rules that determine whether a user qualifies for a specific benefit. You access it by selecting **Edit** on any benefit card.
7472

73+
![Configure Benefit: Food Assistance page of the Benefit Decision Toolkit. The page allows users to browse and select pre-built eligibility checks to add to the Food Assistance benefit. The interface includes tabs for 'Public checks' and 'Your checks.' The table lists several checks with columns for 'Add,' 'Check Name,' 'Description,' and 'Version.' The checks listed are 'Someone-min-age,' 'Person-min-age,' 'Person-max-age,' 'Owner-occupant,' and 'Person-enrolled-in-benefit,' all with version 0.6.0. There is a 'Back' button in the upper right corner, and the navigation bar at the top includes links to 'Food & Heating Assistance,' 'Manage Benefits,' 'Form Editor,' 'Preview,' and 'Publish.](images/configure-benefit-1.png)
74+
7575
Each benefit contains one or more **Eligibility Checks**.
7676

7777
> A user is considered **eligible for the benefit only if every eligibility check evaluates to `True`.**
@@ -106,7 +106,7 @@ Each row in the list shows the check name, a brief description, and its version.
106106

107107
Once added, the check appears as a card in the right panel under the benefit's configured checks.
108108

109-
> TODO: Add image of Configure Benefit page showing the check list and selected checks panel
109+
![A user interface for selecting eligibility checks related to food assistance, featuring a list of available criteria such as person enrolled in benefit, person not enrolled in benefit, lives in Philadelphia Pennsylvania, no ten year tax abatement, and ten year tax abatement. Below this list, the section titled selected eligibility checks for food assistance shows two criteria already chosen: lives in Philadelphia Pennsylvania, and person minimum age with parameters including person ID as applicant, as of date February 28 2026, and minimum age of 18.](images/configure-benefit-2.png)
110110

111111
### 4.3 Configuring Check Parameters
112112

@@ -118,7 +118,7 @@ To configure the parameters for an added check, click on its card in the right p
118118

119119
Fill in the value for each parameter and select **Confirm** to save. Required parameters are marked with a red asterisk (`*`).
120120

121-
> TODO: Add image of Configure Check modal
121+
![Configure Check: Person-min-age dialog box in the Benefit Decision Toolkit. The dialog box allows users to set parameters for the Person-min-age check. The parameters include PersonId set to 'applicant', AsOfDate set to '02/28/2026', and MinAge set to '18'. The dialog box has Cancel and Confirm buttons at the bottom. The background shows a list of eligibility checks with options to add more checks such as Person-not-enrolled-in-benefit, Lives-in-philadelphia, and Person-min-age with their respective parameters.](images/configure-check.png)
122122

123123
### 4.4 Removing a Check
124124

@@ -132,16 +132,18 @@ The **Form Editor** tab is where you build the user-facing form that collects th
132132

133133
The editor provides a visual drag-and-drop canvas powered by Form-JS. You can add, arrange, and configure form fields without writing any code.
134134

135+
![Screenshot of the Benefit Decision Toolkit interface showing the Form Editor for a food assistance form. The image highlights the 'Checkbox group' component in the 'Selection' section, indicated by a red circle and an arrow pointing to the 'Checkbox group' option. The form includes fields such as 'Do you live in Philly?', 'Enter your birthday', 'Do you own your house?', and a checkbox for 'Select benefit you are enrolled in'. The interface includes tabs for 'Food & Heating Assistance', 'Manage Benefits', 'Form Editor', 'Preview', and 'Publish'. There is also a 'Save' button and an option to 'Validate Form Outputs'.](images/form-editor-components.png)
136+
135137
**Saving your work**:
136138

137139
Select **Save** to persist your form. The save button turns yellow when there are unsaved changes, so you can tell at a glance whether your current edits have been saved.
138140

139-
> TODO: Add image of Form Editor
140-
141141
### 5.1 Connecting Form Fields to Eligibility Checks
142142

143143
For the screener to evaluate eligibility correctly, the form must collect all of the inputs that the configured eligibility checks require. Each form field has a **key** that identifies the data it collects — this key must match the input name expected by the corresponding eligibility check.
144144

145+
![Screenshot of the Benefit Decision Toolkit's Form Editor interface. The form includes a 'Yes/No' component asking 'Do you live in Philly?' with options for 'Yes' and 'No'. The component settings on the right side show the 'Key' field populated with 'simpleChecks.livesInPhiladelphia' and the 'Field label' field populated with 'Do you live in Philly?'. The form also includes fields for entering a birthday, a question about home ownership, and a checkbox for selecting a benefit. The interface includes various input, selection, and presentation components on the left side for building the form. There is a 'Save' button at the top right and a 'Validate Form Outputs' button at the bottom right.](images/form-editor-parameters.png)
146+
145147
The **Validate Form Outputs** drawer (accessible via a button at the bottom-right of the editor) helps you verify that your form covers all required inputs. It shows:
146148

147149
- **Form Outputs** — a list of all fields currently defined in the form and the data they will collect
@@ -150,7 +152,7 @@ The **Validate Form Outputs** drawer (accessible via a button at the bottom-righ
150152

151153
Use this drawer to identify gaps between your form and your eligibility logic, and resolve any missing inputs before moving to the Preview step.
152154

153-
> TODO: Add image of Validate Form Outputs drawer
155+
![A form outputs section that lists the form outputs such as simpleChecks livesInPhiladelphiaPa, people applicant dateOfBirth, simpleChecks ownerOccupant, and people applicant enrollments. Below that, the missing inputs section indicates all required inputs are satisfied. The satisfied inputs section lists and confirms the inputs including people applicant dateOfBirth, people applicant enrollments, simpleChecks livesInPhiladelphiaPa, and simpleChecks ownerOccupant with their respective data types.](images/form-validation.png)
154156

155157
---
156158

@@ -164,6 +166,8 @@ The preview screen is divided into two sections:
164166

165167
Displays your screener form as it will appear to end users. Fill in the fields and select **Submit** to run the eligibility evaluation.
166168

169+
![Screenshot of the Benefit Decision Toolkit's form preview interface. The form includes several questions: 'Do you live in Philly?' with 'Yes' selected, a field to 'Enter your birthday' with the date '02 01 1990' filled in, 'Do you own your house?' with 'Yes' selected, and a checkbox to 'Select benefit you are enrolled in' with 'Food Assistance' selected. Below the form, the 'Results' section shows the 'Inputs'.](images/preview-inputs.png)
170+
167171
**Results section**:
168172

169173
After submitting, the results section displays the outcome for each benefit:
@@ -172,12 +176,12 @@ After submitting, the results section displays the outcome for each benefit:
172176
- **Ineligible** (red) — one or more eligibility checks returned `False`
173177
- **Need more information** (yellow) — one or more checks could not determine eligibility from the inputs provided
174178

179+
![Results section of a benefits eligibility tool. The Inputs section shows the following data: simpleChecks: { "livesInPhiladelphiaPa": true, "ownerOccupant": true }, people: { "applicant": { "dateOfBirth": "1990-02-01", "enrollments": [ "Food Assistance" ] } }. The Benefits section shows the following eligibility results: Food Assistance: Eligible, lives-in-philadelphia-pa (residence v0.6.0), person-in-phil-age (age v0.6.0), minAge=18, personId=applicant, asOfDate=2026-02-28. Heating Assistance: Eligible, person-enrolled-in-benefit (enrollment v0.6.0), personId=applicant, benefit=Food Assistance, person-min-age (age v0.6.0), minAge=18, personId=applicant, asOfDate=2026-02-28, owner-occupant (residence v0.6.0).](images/preview-results.png)
180+
175181
Each benefit's result also shows a breakdown of how each individual eligibility check evaluated, including whether it passed, failed, or was unable to determine, and what parameter values were used. This detail is useful for debugging eligibility logic during development.
176182

177183
> Use the Preview tab iteratively as you build your screener to confirm that each benefit evaluates correctly across a range of test inputs.
178184
179-
> TODO: Add image of Preview tab with a sample result
180-
181185
---
182186

183187
## 7. Publishing Your Screener
@@ -197,7 +201,7 @@ The Publish tab shows:
197201
198202
If you update your screener after publishing, return to the **Publish** tab and select **Deploy Screener** again to push the updated version to the public URL.
199203

200-
> TODO: Add image of Publish tab showing public URL
204+
![The image shows a form and eligibility results for Food & Heating Assistance. The form asks if the user lives in Philly, with "Yes" selected, and prompts the user to enter their birthday, which is filled in as 2/18/1990. It also asks if the user owns their house, with "No" selected, and allows the user to select the benefit they are enrolled in, with "Food Assistance" chosen. The eligibility results section indicates that the user is eligible for Food Assistance, meeting criteria such as residence in Philadelphia and being at least 18 years old. However, the user is ineligible for Heating Assistance because, although they meet age and enrollment criteria, they do not meet the owner-occupant residence requirement.](images/published-screener.png)
201205

202206
---
203207

0 commit comments

Comments
 (0)