diff --git a/.github/workflows/broken-links-checker.yml b/.github/workflows/broken-links-checker.yml index 83cef829..61546eb6 100644 --- a/.github/workflows/broken-links-checker.yml +++ b/.github/workflows/broken-links-checker.yml @@ -37,7 +37,7 @@ jobs: uses: lycheeverse/lychee-action@v2.6.1 with: args: > - --verbose --exclude-mail --no-progress --exclude ^https?:// + --verbose --no-progress --exclude ^https?:// ${{ steps.changed-markdown-files.outputs.all_changed_files }} failIfEmpty: false env: @@ -50,8 +50,8 @@ jobs: uses: lycheeverse/lychee-action@v2.6.1 with: args: > - --verbose --exclude-mail --no-progress --exclude ^https?:// + --verbose --no-progress --exclude ^https?:// '**/*.md' failIfEmpty: false env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/docs/DeploymentGuide.md b/docs/DeploymentGuide.md index 5567213b..432da979 100644 --- a/docs/DeploymentGuide.md +++ b/docs/DeploymentGuide.md @@ -258,4 +258,9 @@ If you run into issue with PowerShell script file not being digitally signed, yo ``` powershell.exe -ExecutionPolicy Bypass -File ".\uploadfiles.ps1" -EndpointUrl https://kmgs..cloudapp.azure.com -``` \ No newline at end of file +``` + +## Next Steps +Now that you've completed your deployment, you can start using the solution. + +To help you get started, here are some [Sample Questions](./SampleQuestions.md) you can follow to try it out. diff --git a/docs/SampleQuestions.md b/docs/SampleQuestions.md new file mode 100644 index 00000000..0db06c42 --- /dev/null +++ b/docs/SampleQuestions.md @@ -0,0 +1,45 @@ +# Sample Questions + +To help you get started, here are some **Sample Prompts** you can ask in the app: + +## **Housing Affordability & Report Analysis** +Prompts focus on housing issues, document filtering, and comparing annual report outcomes. + +### **Overview** +_Sample Workflow:_ + +- Question: What are the main factors contributing to the current housing affordability issues? +- Task: Click one of the **suggested follow-up question** and related response is generated. +- Task: Click **New topic** button to clear the chat conversation. + +### **Housing Report** +Explore key findings, compare annual data, and review detailed housing insights. + +_Sample Workflow:_ + +- Task: Search for the keyword **Housing Report** to filter the document list and display only relevant results. +- Task: Select two documents **(Annual Housing Report 2022 & 2023)** right top panel is switched to **2 Selected** tab. +![housing](images/readme/dkm_housing.png) +- Question: Analyze the two annual reports and compare the positive and negative outcomes YoY. Show the results in a table. +- Task: Click **Details** on the **Annual Housing Report 2023** document to display the pop-up viewer. +- Task: Review the Extractive Summary for accuracy. +- Task: Scroll through the pages of the document until page **10** & **11**. +- Task: Click on **Chat** tab +- Question: Can you summarize and compare the tables on page **10** and **11**? + +### **Contracts** +Review, analyze, and extract key details from handwritten contract documents. + +_Sample Workflow:_ + +- Task: Search for the keyword **Contracts** to filter the document list and display only relevant results. +- Task: Select **3** to **4**, **handwritten contract documents**. +- Question: Analyze these forms and create a table with all buyers, sellers, and corresponding purchase prices. +- Task: Click **Details** button on one of the handwritten contracts to display the pop-up viewer. +- Task: Click on **Chat** tab +- Question: What liabilities is the buyer responsible for within the contract? + + +Enables faster insight discovery and smarter data analysis through automated content extraction and chat-based guidance. + + diff --git a/docs/images/readme/dkm_housing.png b/docs/images/readme/dkm_housing.png new file mode 100644 index 00000000..ab60f249 Binary files /dev/null and b/docs/images/readme/dkm_housing.png differ