Skip to content

Commit b5fe36a

Browse files
authored
docs(github pages): moved threat model to GitHub pages site. Updated README to direct users there (#33)
Threat Model documentation was removed from the root of the repo and moved into the GitHub pages static site for improved readability. The README documentation has been updated to direct users to this page. re #32
1 parent dacdf50 commit b5fe36a

8 files changed

+16
-232
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Generative AI Newsletter Application sample is a ready-to-use serverless sol
1010

1111
The application offers users the ability to influence the generative AI prompts to customize how content is summarized such as the tone, intended audience, and more. Users can stylize the HTML newsletter, define how frequently newsletters are created and share the newsletters with others.
1212

13-
![Generative AI Newsletter Application Welcome Page](./documentation-assets/Generative-AI-Newsletter-App-Landing-Image.png)
13+
![Generative AI Newsletter Application Welcome Page](./pages/images/Generative-AI-Newsletter-App-Landing-Image.png)
1414

1515

1616
## Author
@@ -22,7 +22,7 @@ The application offers users the ability to influence the generative AI prompts
2222

2323
## Threat Model
2424

25-
Review the threat model developed for the solution [here](THREAT_MODEL.md). Additionally, you can download the [Threat Model JSON](documentation-assets/GenAINewsletter_ThreatComposer.json) and view the visualized threat model by importing the JSON into [Threat Composer](https://awslabs.github.io/threat-composer/workspaces/default/dashboard).
25+
The threat model for this solution can be found [here](https://aws-samples.github.io/generative-ai-newsletter-app/threat-model).
2626

2727
## License
2828

USER_GUIDE.md

-87
This file was deleted.
Binary file not shown.

pages/about.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ This serverless solution leverages a variety of AWS services, including Lambda,
3535

3636
## Get Started
3737

38-
To begin using the AWS Serverless Feed Summarizer and Newsletter Solution, simply log in to the application and follow the [user guide](user-guide) to set up your data feeds, create newsletters, and manage your subscribers.
38+
To begin using the AWS Serverless Feed Summarizer and Newsletter Solution, simply log in to the application and follow the [user guide](./user-guide) to set up your data feeds, create newsletters, and manage your subscribers.
3939

40-
If you have any questions or need further assistance, please don't hesitate to reach out to our support team.
40+
If you have any questions or need further assistance, please don't hesitate to reach out to our support team.
41+
42+
## Threat Model
43+
To learn more about the security and threat modeling of the solution, visit the [threat model](./threat-model) page.

0 commit comments

Comments
 (0)