2473160 document update to QuickStart.md #134
Conversation
Updated instructions for clarity and corrected numbering.
There was a problem hiding this comment.
Pull request overview
This pull request adds documentation improvements to help users understand the end-to-end process of getting a Dragon Copilot extension working. However, there is a critical discrepancy: while the PR description mentions adding comprehensive flow documentation to QUICKSTART.md, the actual QUICKSTART.md changes are missing from this PR.
Key Changes:
- Added a link in README.md pointing to QUICKSTART.md
- Added 6 PNG image files to the doc/ directory to support documentation
Reviewed changes
Copilot reviewed 2 out of 24 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Added link to QUICKSTART.md guide (but QUICKSTART.md changes not included in PR) |
| doc/timeline-output.png | Binary image file added (198 lines) |
| doc/tab-note.png | Binary image file added (18 lines) |
| doc/settings-switch-environment-3.png | Binary image file added (150 lines) |
| doc/settings-style.png | Binary image file added (49 lines) |
| doc/settings-note-style.png | Binary image file added (65 lines) |
| doc/settings-gear.png | Binary image file added (12 lines) |
Updated based on copilot suggestion. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
README.md
Outdated
|
|
||
|
|
||
|
|
||
| Look here for a guide describing the process from downloading code to testing it in Dragon Copilot: [QUICKSTART.md](/QUICKSTART.md) |
There was a problem hiding this comment.
Would this make more sense in the quick start section of the readme?
There was a problem hiding this comment.
can we also add references from the Learn documentation into the relevant sections? including thereference to the adaptive card specification ?
There was a problem hiding this comment.
@brandonpollett I updated the location of the links to the readme.
@almasc15 I added links in the quickstart document to the Microsoft Learn documentation.
Added a link to the QUICKSTART guide in the README.
almasc15
left a comment
There was a problem hiding this comment.
As part of the overall extension development experience, please call out that the developer has access to audio examples
Updated the Quick Start Guide to improve structure and clarity, including a new Table of Contents and revised sections for running locally and testing the extension.
Updated the Table of Contents with additional descriptions for sections.
Updated the title and added links to Microsoft Learn documentation for better guidance.
Updated sample script and added reference to audio recordings.
@microsoft-github-policy-service agree company="Microsoft" |
I added a link and comment in the "Testing your extension" step 8. |
Updated links and clarified instructions for Process API and packaging.
Moved quick start guide reference in README.
Add files for registering service principal section to better display how to register the Microsoft.HealthPlatform SP.
Adding subscription image to use in service principal section.
Added instructions for registering the Microsoft.HealthPlatform resource provider and creating an application in Azure.
Clarify the registration of the Microsoft.HealthPlatform resource provider and note that it only needs to be done once.
Using a block quote for better emphasis for the reader to notice the comments. Co-authored-by: Brandon Pollett <brandon.pollett@gmail.com>
* added a python sample * deps(deps): bump @inquirer/prompts in /tools/dragon-extension-cli (#117) Bumps [@inquirer/prompts](https://github.com/SBoudrias/Inquirer.js) from 7.9.0 to 7.10.0. - [Release notes](https://github.com/SBoudrias/Inquirer.js/releases) - [Commits](https://github.com/SBoudrias/Inquirer.js/compare/@inquirer/prompts@7.9.0...@inquirer/prompts@7.10.0) --- updated-dependencies: - dependency-name: "@inquirer/prompts" dependency-version: 7.10.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * updated copilot review * Adaptive card sample updates (#121) * Updates to the adaptive card that's generated. * Update AdaptiveCardPayload.cs * added audio recordings to samples (#88) * added audio recordings to samples * added reference to sample audio-recordings * added reference to sample audio-recordings * deps(deps-dev): bump @types/archiver in /tools/dragon-extension-cli (#113) Bumps [@types/archiver](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/archiver) from 6.0.3 to 7.0.0. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/archiver) --- updated-dependencies: - dependency-name: "@types/archiver" dependency-version: 7.0.0 dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps(deps): bump glob in /tools/dragon-extension-cli (#122) Bumps and [glob](https://github.com/isaacs/node-glob). These dependencies needed to be updated together. Updates `glob` from 10.4.5 to 10.5.0 - [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md) - [Commits](isaacs/node-glob@v10.4.5...v10.5.0) Updates `glob` from 11.0.3 to 11.1.0 - [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md) - [Commits](isaacs/node-glob@v10.4.5...v10.5.0) --- updated-dependencies: - dependency-name: glob dependency-version: 10.5.0 dependency-type: indirect - dependency-name: glob dependency-version: 11.1.0 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * 2473160 document update to QuickStart.md (#134) * 2473160 - Refreshed documentation based on creating an initial extension. * Fix link to QUICKSTART.md in README * Refine QUICKSTART.md for improved clarity Updated instructions for clarity and corrected numbering. * Adding missing images for Quickstart.md * Adding a link and description to the quickstart guide. * Update README.md Updated based on copilot suggestion. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Moved quickstart link to Quickstart section. Added a link to the QUICKSTART guide in the README. * Added images that were missing. * Revise Quick Start Guide for Dragon Extension Developer Updated the Quick Start Guide to improve structure and clarity, including a new Table of Contents and revised sections for running locally and testing the extension. * Reorganize Quick Start Guide for clarity * Enhance Table of Contents with section descriptions Updated the Table of Contents with additional descriptions for sections. * Revise Quick Start Guide for Dragon Extension Developer Updated the title and added links to Microsoft Learn documentation for better guidance. * Revise sample script and add audio recordings reference Updated sample script and added reference to audio recordings. * Clarify Process API and packaging instructions Updated links and clarified instructions for Process API and packaging. * Moved quickstart link to Quickstart section. Moved quick start guide reference in README. * registering service principal images Add files for registering service principal section to better display how to register the Microsoft.HealthPlatform SP. * Add subscription image Adding subscription image to use in service principal section. * Update QUICKSTART.md with Azure registration steps Added instructions for registering the Microsoft.HealthPlatform resource provider and creating an application in Azure. * Clarify Service Principal registration process Clarify the registration of the Microsoft.HealthPlatform resource provider and note that it only needs to be done once. * Update QUICKSTART.md to utilize a block quote Using a block quote for better emphasis for the reader to notice the comments. Co-authored-by: Brandon Pollett <brandon.pollett@gmail.com> --------- Co-authored-by: Timothy Lee <timothy_lee@nuance.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Brandon Pollett <brandon.pollett@gmail.com> * deps(deps): bump actions/checkout from 5 to 6 (#124) Bumps [actions/checkout](https://github.com/actions/checkout) from 5 to 6. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v5...v6) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps: Bump Microsoft.AspNetCore.Authentication.JwtBearer from 9.0.10 to 9.0.11 (#125) --- updated-dependencies: - dependency-name: Microsoft.AspNetCore.Authentication.JwtBearer dependency-version: 9.0.11 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps: Bump Microsoft.AspNetCore.OpenApi from 9.0.10 to 9.0.11 (#126) --- updated-dependencies: - dependency-name: Microsoft.AspNetCore.OpenApi dependency-version: 9.0.11 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps(deps-dev): bump rimraf in /tools/dragon-extension-cli (#130) Bumps [rimraf](https://github.com/isaacs/rimraf) from 6.1.0 to 6.1.2. - [Changelog](https://github.com/isaacs/rimraf/blob/main/CHANGELOG.md) - [Commits](isaacs/rimraf@v6.1.0...v6.1.2) --- updated-dependencies: - dependency-name: rimraf dependency-version: 6.1.2 dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps: Bump Microsoft.Identity.Web from 4.0.1 to 4.3.0 (#138) --- updated-dependencies: - dependency-name: Microsoft.Identity.Web dependency-version: 4.3.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * deps(deps): bump js-yaml in /tools/dragon-extension-cli (#139) Bumps [js-yaml](https://github.com/nodeca/js-yaml) to 4.1.1 and updates ancestor dependency . These dependencies need to be updated together. Updates `js-yaml` from 4.1.0 to 4.1.1 - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@4.1.0...4.1.1) Updates `js-yaml` from 3.14.1 to 3.14.2 - [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md) - [Commits](nodeca/js-yaml@4.1.0...4.1.1) --- updated-dependencies: - dependency-name: js-yaml dependency-version: 4.1.1 dependency-type: direct:production - dependency-name: js-yaml dependency-version: 3.14.2 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * rewrite the README.md for the python workflow extension * clean up md files * updated README.md with cmds to create .venv and start python samlple server * clean up files * Added content table to README.md, updated output structure to accommondate the new adaptive card output version 1.6 * update the adaptive card output * update the reason for choose python 3.12 to avoid integration issues with AIML libs * make format consistent * Updated code based on code review comments. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: yingding <yingdingwang@yahoo.de> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Brandon Pollett <brpoll@microsoft.com> Co-authored-by: Jim McDole <2876054+mcdolejt@users.noreply.github.com> Co-authored-by: leetimj <250227887+leetimj@users.noreply.github.com> Co-authored-by: Timothy Lee <timothy_lee@nuance.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Brandon Pollett <brandon.pollett@gmail.com>
Adding additional a comprehensive flow of what is needed to get an extension to work in Dragon Copilot in the QuickStart.md. Also added a link in the Readme.md and image files to help display the process.