Skip to content

Commit 15352ea

Browse files
iamyumeiamyume
authored
Merge pull request #6 from /issues/4-use-cases
Adding text response use case diagrams diagrams
2 parents a1d1cb4 + d215e80 commit 15352ea

12 files changed

+95
-29
lines changed

‎.github/workflows/plantuml.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: embed plantuml
2+
on: push
3+
jobs:
4+
embed-puml-markdown:
5+
runs-on: ubuntu-latest
6+
name: plantuml
7+
steps:
8+
- name: Check out the repo
9+
uses: actions/checkout@v2
10+
with:
11+
fetch-depth: 0
12+
- name: Embed PlantUML inside Markdown
13+
uses: alessandro-marcantoni/puml-markdown@v0.1.1
14+
- name: Push Local Changes
15+
uses: stefanzweifel/git-auto-commit-action@v4.1.2
16+
with:
17+
commit_message: "Generate PlantUML diagrams"
18+
branch: ${{ github.head_ref }}

‎docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Documentation
22

3-
[State Diagram & Documentation](./states.md)
3+
[State Diagram](./state-diagram.md)
4+
5+
[Use Cases](./use-cases.md)

‎docs/diagrams/case-found-no-reminder-set.puml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@startuml
2+
skinparam sequenceMessageAlign center
3+
4+
User -> Server: 01-AB-23456
5+
Server -> User: We found case "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\nReply with YES if you would like a courtesy reminder the day before or reply with NO to start over.
6+
User -> Server: No
7+
Server -> User: You said no so we won't text you a reminder. You can always go to https://www.vermontjudiciary.org/court-hearings for more information about your case.
8+
@enduml

‎docs/diagrams/case-found-sign-up-for-reminder.puml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@startuml
2+
skinparam sequenceMessageAlign center
3+
4+
User -> Server: 01-AB-23456
5+
Server -> User: We found case "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\nReply with YES if you would like a courtesy reminder the day before or reply with NO to start over.
6+
User -> Server: Yes
7+
Server -> User: Reminder set for case (01-AB-23456)
8+
@enduml

‎docs/diagrams/case-not-found.puml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@startuml
2+
skinparam sequenceMessageAlign center
3+
4+
User -> Server: 01-NOT-FOUND
5+
Server -> User: We did not find any cases that match 01-NOT-FOUND
6+
@enduml

‎docs/diagrams/multiple-cases-no-reminder-set.puml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@startuml
2+
skinparam sequenceMessageAlign center
3+
4+
User -> Server: 01-AB-23456
5+
Server -> User: We found 3 cases.\nReply with a # if you would like a courtesy reminder the day before or reply with NO to start over.\n1 - "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n2 - "01-AB-23456" on 8/1/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n3 - "01-AB-23456" on 8/5/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.
6+
User -> Server: No
7+
Server -> User: You said no so we won't text you a reminder. You can always go to https://www.vermontjudiciary.org/court-hearings for more information about your case.
8+
@enduml

‎docs/diagrams/multiple-cases.puml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
@startuml
2+
skinparam sequenceMessageAlign center
3+
4+
User -> Server: 01-AB-23456
5+
Server -> User: We found 3 cases.\nReply with a # if you would like a courtesy reminder the day before or reply with NO to start over.\n1 - "01-AB-23456" on 7/28/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n2 - "01-AB-23456" on 8/1/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.\n3 - "01-AB-23456" on 8/5/2022 1:00 PM @ Family/Criminal Courtroom 2A Chittenden, VT.
6+
User -> Server: 2
7+
Server -> User: Reminder set for case (01-AB-23456)
8+
@enduml

‎docs/diagrams/regex-not-matched.puml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
@startuml
2+
skinparam sequenceMessageAlign center
3+
4+
User -> Server: not a valid input
5+
Server -> User: Reply with a docket number to sign up for a reminder. Docket numbers look like 3 sets of numbers or characters. For example: 123-45-67 or 123-CR-45.
6+
@enduml

‎docs/state-diagram.puml renamed to ‎docs/diagrams/state-diagram.puml

File renamed without changes.

‎docs/state-diagram.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# API States
2+
3+
## State Diagram
4+
5+
[![State Diagram](https://tinyurl.com/2nfyuxmj)](https://tinyurl.com/2nfyuxmj)<!--![State Diagram](./diagrams/state-diagram.puml)-->

‎docs/states.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

‎docs/use-cases.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Use Cases
2+
3+
## User successfully finds a case and signs up for a reminder
4+
5+
[![User successfully finds a case and signs up for a reminder](https://tinyurl.com/2frde86r)](https://tinyurl.com/2frde86r)<!--![User successfully finds a case and signs up for a reminder](./diagrams/case-found-sign-up-for-reminder.puml)-->
6+
7+
## User doesn't find a case
8+
9+
[![User doesn't find a case](https://tinyurl.com/2llf9cvy)](https://tinyurl.com/2llf9cvy)<!--![User doesn't find a case](./diagrams/case-not-found.puml)-->
10+
11+
## User enters an input that doesn't match regex
12+
13+
[![User enters an input that doesn't match regex](https://tinyurl.com/2ql2o2s7)](https://tinyurl.com/2ql2o2s7)<!--![User enters an input that doesn't match regex](./diagrams/regex-not-matched.puml)-->
14+
15+
## User finds a case but doesn't sign up for notification
16+
17+
[![User finds a case but doesn't sign up for notification](https://tinyurl.com/2e5hkbzp)](https://tinyurl.com/2e5hkbzp)<!--![User finds a case but doesn't sign up for notification](./diagrams/case-found-no-reminder-set.puml)-->
18+
19+
## User finds multiple cases
20+
21+
[![User finds multiple cases](https://tinyurl.com/2nab39j3)](https://tinyurl.com/2nab39j3)<!--![User finds multiple cases](./diagrams/multiple-cases.puml)-->
22+
23+
## User finds multiple cases but replies no
24+
25+
[![User finds multiple cases but replies no](https://tinyurl.com/2r24h7rq)](https://tinyurl.com/2r24h7rq)<!--![User finds multiple cases but replies no](./diagrams/multiple-cases-no-reminder-set.puml)-->

0 commit comments

Comments
 (0)