-
Notifications
You must be signed in to change notification settings - Fork 70
docs: Added new Sample Questions page and reference file #257
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
Conversation
Added sample questions and operational tasks for users.
Updated the deployment guide to reference a sample workflow for testing the application instead of specific Informix queries.
Updated the document to reflect a workflow instead of questions.
Updated the Sample Workflow documentation to clarify processes, improve readability, and enhance instructions for users.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a new Sample Workflow documentation file and updates the Deployment Guide to reference it. The changes improve user onboarding by providing a dedicated, structured workflow document with clear instructions and a visual guide for testing the application with sample data.
- Created a new
SampleWorkflow.mddocument with step-by-step instructions for Upload, Review, and Download operations - Updated
DeploymentGuide.mdto reference the new Sample Workflow document instead of inline sample data instructions - Added a screenshot image (
samplecodmod1.png) to visually support the workflow documentation
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/images/samplecodmod1.png | New screenshot image showing the application interface for the sample workflow |
| docs/SampleWorkflow.md | New documentation file providing a structured step-by-step workflow for testing the application |
| docs/DeploymentGuide.md | Updated to reference the new Sample Workflow document instead of inline instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/SampleWorkflow.md
Outdated
| - The batch Processing page will get opened up and the translation process will be visible. One file at a time will be processed and others will be in queued state. | ||
| - Once the batch Processing is done for any file, file is available to review. |
Copilot
AI
Nov 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent capitalization: 'batch Processing' should be 'batch processing' (lowercase 'p').
| - The batch Processing page will get opened up and the translation process will be visible. One file at a time will be processed and others will be in queued state. | |
| - Once the batch Processing is done for any file, file is available to review. | |
| - The batch processing page will get opened up and the translation process will be visible. One file at a time will be processed and others will be in queued state. | |
| - Once the batch processing is done for any file, file is available to review. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Added note about average translating time.
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.