docs: Added new Sample Questions page and reference file #492
Conversation
Added sample questions to guide users in the app's Browse section.
Updated sample questions for housing affordability and report analysis.
Added next steps and sample questions after deployment instructions.
Updated sample questions and workflows for housing affordability, housing reports, and contracts sections.
Updated instructions for the Housing Report and Contracts sections, including new tasks and questions.
Refined sample prompts for housing affordability and contract analysis workflows.
Atulku-Microsoft
requested review from
Avijit-Microsoft,
Dongbumlee,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft and
aniaroramsft
as code owners
There was a problem hiding this comment.
Pull Request Overview
This pull request adds sample questions documentation to help users get started with the application. The changes include:
- A new
SampleQuestions.mdfile with workflow examples for housing affordability analysis and contract review - A reference link added to
DeploymentGuide.mddirecting users to the sample questions - An accompanying image (
dkm_housting.png) to illustrate the housing report workflow
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/SampleQuestions.md | New documentation file providing sample prompts and workflows for housing reports and contracts analysis |
| docs/DeploymentGuide.md | Added "Next Steps" section linking to the new sample questions documentation |
| docs/images/readme/dkm_housting.png | New screenshot image showing the housing report interface (binary file) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Prompts focus on housing issues, document filtering, and comparing annual report outcomes. | ||
|
|
||
| ### **Overview** | ||
| _Sample Worlflow:_ |
There was a problem hiding this comment.
Corrected spelling of 'Workflow' from 'Worlflow'.
| _Sample Worlflow:_ | |
| _Sample Workflow:_ |
| _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. |
There was a problem hiding this comment.
Missing period at the end of the sentence. The sentence should end with a period for consistency with other task items.
|
|
||
| - 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. | ||
|  |
There was a problem hiding this comment.
The image filename contains a typo - 'housting' should be 'housing'. Consider renaming the file to maintain consistency and professionalism.
|  | |
|  |
| - 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**?. |
There was a problem hiding this comment.
Double punctuation detected - there's both a question mark and a period. Remove the period after the question mark.
| - Question: Can you summarize and compare the tables on page **10** and **11**?. | |
| - Question: Can you summarize and compare the tables on page **10** and **11**? |
|
|
||
| _Sample Workflow:_ | ||
|
|
||
| - Search for the keyword **Contracts** to filter the document list and display only relevant results. |
There was a problem hiding this comment.
This line is missing the 'Task:' prefix that's used consistently in other workflow items. Add 'Task:' at the beginning for consistency.
| - Search for the keyword **Contracts** to filter the document list and display only relevant results. | |
| - Task: Search for the keyword **Contracts** to filter the document list and display only relevant results. |
| _Sample Workflow:_ | ||
|
|
||
| - Search for the keyword **Contracts** to filter the document list and display only relevant results. | ||
| - Task: Select **3** to **4**, **handwritten contract documents**. |
There was a problem hiding this comment.
Double space detected between the comma and 'handwritten'. Remove the extra space.
| - Task: Select **3** to **4**, **handwritten contract documents**. | |
| - Task: Select **3** to **4**, **handwritten contract documents**. |
Purpose
This pull request updates the deployment documentation to improve the discoverability and clarity of sample process, users can follow in the app.
Does this introduce a breaking change?
Other Information
Added new page and reference link in DeploymentGuide.md.