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

Conversation

Roopan-Microsoft
Copy link
Contributor

Purpose

  • This pull request includes updates to the documentation to help users get started with the application and improve the overall user experience. The most important changes include the addition of a new section for sample questions and the introduction of a detailed guide on using the application's features.

Documentation updates:

  • README.md: Added a new section titled "Sample Questions" to guide users on how to use the application effectively.
  • docs/SampleQuestions.md: Created a new file with detailed sample questions and prompts for different sections of the application, including Browse, Generate, and Draft sections. This helps users understand the functionalities and operations they can perform within the app.

Formatting improvements:

  • README.md: Removed unnecessary blank lines to improve the readability of the document.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation - NA

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation - NA

  • I have validated the deployment process successfully and all services are running as expected with this change.

What to Check

Verify that the following are valid - NA

  • I have built and tested the code locally and in a deployed app
  • For frontend changes, I have pulled the latest code from main, built the frontend, and committed all static files.
  • This is a change for all users of this app. No code or asset is specific to my use case or my organization.

Other Information

@Prajwal-Microsoft Prajwal-Microsoft merged commit c6feddc into main Mar 26, 2025
10 checks passed
@Roopan-Microsoft Roopan-Microsoft deleted the psl-prompts-readme branch March 27, 2025 08:36
Copy link

github-actions bot commented Apr 5, 2025

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants