Skip to content

Commit

Permalink
docs(github pages): moved threat model to GitHub pages site. Updated …
Browse files Browse the repository at this point in the history
…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
  • Loading branch information
flamingquaks authored May 9, 2024
1 parent dacdf50 commit b5fe36a
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 232 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Generative AI Newsletter Application sample is a ready-to-use serverless sol

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.

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


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

## Threat Model

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).
The threat model for this solution can be found [here](https://aws-samples.github.io/generative-ai-newsletter-app/threat-model).

## License

Expand Down
87 changes: 0 additions & 87 deletions USER_GUIDE.md

This file was deleted.

Binary file not shown.
7 changes: 5 additions & 2 deletions pages/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ This serverless solution leverages a variety of AWS services, including Lambda,

## Get Started

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.
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.

If you have any questions or need further assistance, please don't hesitate to reach out to our support team.
If you have any questions or need further assistance, please don't hesitate to reach out to our support team.

## Threat Model
To learn more about the security and threat modeling of the solution, visit the [threat model](./threat-model) page.
File renamed without changes.
Loading

0 comments on commit b5fe36a

Please sign in to comment.