Skip to content

docs: updates to the documentation to help users get started with the application #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,9 @@ Additional Steps

Follow steps in [Delete Resource Group](./docs/DeleteResourceGroup.md) If your deployment fails and you need to clean up the resources.

## Sample Questions

To help you get started, here are some [Sample Questions](./docs/SampleQuestions.md) you can follow once your application is up and running.

<!--

Expand Down Expand Up @@ -246,8 +248,6 @@ To add further access controls, update the logic in `getUserInfoList` in `fronte
### Local deployment
Review the local deployment [README](./docs/README_LOCAL.md). -->



<h2>
</br>
Responsible AI Transparency FAQ
Expand Down
35 changes: 35 additions & 0 deletions docs/SampleQuestions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Sample Questions

To help you get started, here are some **Sample Prompts** you can ask in the app:

## **Sections**

### **Browse**
The Browse section allows users to explore and retrieve information related to promissory notes. Key functionalities include:

_Sample Questions:_

- What are typical sections in a promissory note?
- List the details of two promissory notes governed by the laws of the state of California.

### **Generate**
The Generate section enables users to create new promissory notes with customizable options. Key features include:

_Sample Questions:_

- Generate a promissory note with a proposed $100,000 for Washington State.
- Remove (section) <Promissory Note> (Any displayed section you can add).
- Add a Payment acceleration clause after the payment terms section.
- Click on Generate Draft.

![GenerateDraft](images/GenerateDraft.png)

### **Draft**
The Draft section ensures accuracy and completeness of the generated promissory notes. Key tasks include:

_Sample operation:_

- Task: Re-generate text boxes if they did not populate for any section.
- Task: Re-generate text box for Borrower with the name: Jane Smith.

This structured approach ensures that users can efficiently browse, create, and refine promissory notes while maintaining legal compliance and document accuracy.
Binary file added docs/images/GenerateDraft.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading