Add AI-generated documentation prompt for eShopLite scenarios #36
Conversation
|
👋 Thanks for contributing @elbruno! We will review the pull request and get back to you soon. |
Check Country Locale in URLsWe have automatically detected added country locale to URLs in your files. Check the file paths and associated URLs inside them.
|
Check Broken PathsWe have automatically detected the following broken relative paths in your files. Check the file paths and associated broken paths inside them.
|
@copilot remove the '/en-us/' from the url in that page |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive AI prompt to generate documentation and Playwright-based UI tests for select eShopLite .NET Aspire scenarios.
- Introduces
prompts/generate-scenarios-docs.mdwith a step-by-step workflow covering code analysis, docs generation, Playwright scripts, screenshots, and README updates. - Targets four specific scenario folders (
01-SemanticSearch,03-RealtimeAudio,05-deepseek,08-Sql2025). - Defines output structure and naming conventions for generated docs and assets.
Comments suppressed due to low confidence (2)
prompts/generate-scenarios-docs.md:9
- [nitpick] The scenario folder name uses lowercase for 'deepseek' while others use camel case. For consistency, consider using '05-DeepSeek' to match the naming style of the other scenarios.
- 05-deepseek
prompts/generate-scenarios-docs.md:6
- [nitpick] It may help readers to know why only these four scenarios are selected. Consider adding a brief note on the selection criteria or making the list of scenarios configurable to support additional cases in the future.
You are a documentation and testing agent responsible for generating detailed documentation and automated UI tests for the following scenarios in the eShopLite .NET Aspire sample:
@copilot remove the '/en-us/' from the link in that page |
Check Broken URLsWe have automatically detected the following broken URLs in your files. Review and fix the paths to resolve this issue. Check the file paths and associated broken URLs inside them.
|
This pull request introduces a new AI-generated documentation prompt for the
eShopLite .NET Aspiresample, aimed at streamlining the generation of detailed documentation and automated UI tests for specific scenarios. The prompt outlines a comprehensive workflow, including code analysis, documentation creation, Playwright-based testing, and screenshot embedding.Documentation and Testing Workflow:
prompts/generate-scenarios-docs.mdfor generating documentation and automated UI tests for scenarios such as01-SemanticSearch,03-RealtimeAudio,05-deepseek, and08-Sql2025. The workflow includes analyzing.NET Aspiresolution files, creating feature-specific markdown documentation, generating screenshots using Playwright, and updating README files.