Skip to content

2473160 document update to QuickStart.md #134

Merged
leetimj merged 21 commits intomicrosoft:mainfrom
leetimj:2473160_document_update
Jan 12, 2026
Merged

2473160 document update to QuickStart.md #134
leetimj merged 21 commits intomicrosoft:mainfrom
leetimj:2473160_document_update

Conversation

@leetimj
Copy link
Contributor

@leetimj leetimj commented Dec 19, 2025

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.

Copy link
Contributor

Copilot AI left a 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 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>
@leetimj leetimj requested a review from almasc15 December 19, 2025 19:12
README.md Outdated



Look here for a guide describing the process from downloading code to testing it in Dragon Copilot: [QUICKSTART.md](/QUICKSTART.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this make more sense in the quick start section of the readme?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we also add references from the Learn documentation into the relevant sections? including thereference to the adaptive card specification ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brandonpollett I updated the location of the links to the readme.

@almasc15 I added links in the quickstart document to the Microsoft Learn documentation.

Copy link

@almasc15 almasc15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
@leetimj
Copy link
Contributor Author

leetimj commented Jan 6, 2026

@leetimj please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree company="Microsoft"

@leetimj
Copy link
Contributor Author

leetimj commented Jan 6, 2026

As part of the overall extension development experience, please call out that the developer has access to audio examples

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.
leetimj and others added 2 commits January 9, 2026 09:38
Using a block quote for better emphasis for the reader to notice the comments.

Co-authored-by: Brandon Pollett <brandon.pollett@gmail.com>
@leetimj leetimj merged commit e4528e7 into microsoft:main Jan 12, 2026
6 checks passed
@leetimj leetimj deleted the 2473160_document_update branch January 12, 2026 21:20
leetimj added a commit that referenced this pull request Mar 13, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants