Skip to content

Update Foundry Toolkit overview documentation - #10319

Open
Bob Tabor (bobtabor-msft) wants to merge 1 commit into
microsoft:mainfrom
bobtabor-msft:foundry-toolkit-onb-01
Open

Bob Tabor (bobtabor-msft) wants to merge 1 commit into
microsoft:mainfrom
bobtabor-msft:foundry-toolkit-onb-01

Conversation

@bobtabor-msft

Copy link
Copy Markdown
Contributor

Summary

This PR updates the Foundry Toolkit overview documentation for VS Code.

Changes include:

  • Refreshing the overview copy to better describe the current Foundry Toolkit experience
  • Simplifying the intended audience and use-case description
  • Updating installation and prerequisite guidance
  • Revising the My Resources, Developer Tools, Monitor, and Help and Feedback sections
  • Removing outdated Foundry sidebar retirement content
  • Updating overview screenshots to match the current UI

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Replace hardcoded product names with the existing documentation variables.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates Foundry Toolkit overview documentation for VS Code with current setup guidance, feature descriptions, and UI screenshots.

Changes:

  • Refreshes overview, audience, installation, and prerequisite guidance.
  • Revises resource, developer tool, monitoring, and support sections.
  • Updates all overview screenshots.
File summaries
File Description
docs/intelligentapps/overview.md Updated overview documentation and setup guidance.
docs/intelligentapps/images/overview/tracing.png Refreshed tracing screenshot.
docs/intelligentapps/images/overview/tool-catalog.png Refreshed tool catalog screenshot.
docs/intelligentapps/images/overview/model-playground.png Refreshed model playground screenshot.
docs/intelligentapps/images/overview/model-evaluation.png Refreshed model evaluation screenshot.
docs/intelligentapps/images/overview/model-conversion.png Refreshed model conversion screenshot.
docs/intelligentapps/images/overview/model-catalog.png Refreshed model catalog screenshot.
docs/intelligentapps/images/overview/install.png Refreshed installation screenshot.
docs/intelligentapps/images/overview/initial-view.png Refreshed initial view screenshot.
docs/intelligentapps/images/overview/fine-tuning.png Refreshed fine-tuning screenshot.
docs/intelligentapps/images/overview/create-agent.png Refreshed create-agent screenshot.
docs/intelligentapps/images/overview/agent-inspector.png Refreshed Agent Inspector screenshot.
docs/intelligentapps/images/overview/agent-builder.png Refreshed Agent Builder screenshot.
Review details

Suppressed comments (4)

docs/intelligentapps/overview.md:36

  • This updated prerequisite hardcodes Visual Studio Code. Use the existing product-name variable in new or updated documentation so the rendered product name remains consistent across locales and pages.
Install the [.NET Runtime](https://learn.microsoft.com/en-us/dotnet/core/install/) before installing or first running Foundry Toolkit for Visual Studio Code.

docs/intelligentapps/overview.md:40

  • The updated install button hardcodes VS Code, replacing the existing product variable. Keep the reusable variable in this new text so the button follows the repository's documentation branding convention.
> <a class="install-extension-btn" href="vscode:extension/ms-windows-ai-studio.windows-ai-studio">Install Foundry Toolkit for VS Code</a>

docs/intelligentapps/overview.md:98

  • This new help description hardcodes GitHub Copilot. Use the existing Copilot product variable, as other Foundry Toolkit documentation does, to keep product naming consistent.
  - **Ask Copilot**: Ask GitHub Copilot questions about Foundry Toolkit.

docs/intelligentapps/overview.md:72

  • This new setup sentence hardcodes Visual Studio Code twice. Replace both occurrences with the existing product-name variable, as required for new or updated documentation content.
If you plan to use Microsoft Foundry cloud resources, sign in when prompted and select a Foundry project from **My Resources**. To set up a Microsoft Foundry project in Visual Studio Code, see [Set up a Microsoft Foundry project in Visual Studio Code](https://learn.microsoft.com/azure/ai-foundry/how-to/develop/set-up-foundry-project-visual-studio-code).
  • Files reviewed: 13/13 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

* Run models locally using ONNX and Ollama for privacy and cost control
* Build and test agents with prompt generation and MCP tool integrations
* Convert and optimize models for deployment across different hardware configurations
Foundry Toolkit is for anyone building AI-powered apps in VS Code. Use it to discover and evaluate models, run models locally, build and test agents, connect tools and knowledge, and deploy AI resources to Microsoft Foundry.

@ntrogh Nick Trogh (ntrogh) left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Bob Tabor (@bobtabor-msft) Can you use variables for VS Code product names?
FYI, if you replace images in-place, users might still get the old cached version for a while.

### Quick installation

> The [.NET Runtime should be installed](https://learn.microsoft.com/en-us/dotnet/core/install/) as Foundry Toolkit depends on it
Install the [.NET Runtime](https://learn.microsoft.com/en-us/dotnet/core/install/) before installing or first running Foundry Toolkit for Visual Studio Code.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Install the [.NET Runtime](https://learn.microsoft.com/en-us/dotnet/core/install/) before installing or first running Foundry Toolkit for Visual Studio Code.
Install the [.NET Runtime](https://learn.microsoft.com/en-us/dotnet/core/install/) before installing or first running Foundry Toolkit for {% data variables.product.prodname_vscode %}.

The fastest way to get started is by installing the extension through the Visual Studio Marketplace:

> <a class="install-extension-btn" href="vscode:extension/ms-windows-ai-studio.windows-ai-studio">Install the Foundry Toolkit for {% data variables.product.prodname_vscode_shortname %}</a>
> <a class="install-extension-btn" href="vscode:extension/ms-windows-ai-studio.windows-ai-studio">Install Foundry Toolkit for VS Code</a>

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
> <a class="install-extension-btn" href="vscode:extension/ms-windows-ai-studio.windows-ai-studio">Install Foundry Toolkit for VS Code</a>
> <a class="install-extension-btn" href="vscode:extension/ms-windows-ai-studio.windows-ai-studio">Install Foundry Toolkit for {% data variables.product.prodname_vscode_shortname %}</a>


Foundry Toolkit opens in its own view, with the Foundry Toolkit icon displayed on the {% data variables.product.prodname_vscode_shortname %} Activity Bar. The extension has three main sections: My Resources, Developer Tools, and Help and Feedback.

If you plan to use Microsoft Foundry cloud resources, sign in when prompted and select a Foundry project from **My Resources**. To set up a Microsoft Foundry project in Visual Studio Code, see [Set up a Microsoft Foundry project in Visual Studio Code](https://learn.microsoft.com/azure/ai-foundry/how-to/develop/set-up-foundry-project-visual-studio-code).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
If you plan to use Microsoft Foundry cloud resources, sign in when prompted and select a Foundry project from **My Resources**. To set up a Microsoft Foundry project in Visual Studio Code, see [Set up a Microsoft Foundry project in Visual Studio Code](https://learn.microsoft.com/azure/ai-foundry/how-to/develop/set-up-foundry-project-visual-studio-code).
If you plan to use Microsoft Foundry cloud resources, sign in when prompted and select a Foundry project from **My Resources**. To set up a Microsoft Foundry project in {% data variables.product.prodname_vscode_shortname %}, see [Set up a Microsoft Foundry project in {% data variables.product.prodname_vscode_shortname %}](https://learn.microsoft.com/azure/ai-foundry/how-to/develop/set-up-foundry-project-visual-studio-code).

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