PSOT Go YAML Creator for VS Code

PSOT Go is a Visual Studio Code extension that streamlines the creation and management of YAML metadata for Markdown-based learning modules. It leverages Azure OpenAI and LLMs to automatically generate structured YAML files for units, knowledge checks, and module indexes, using the content of your Markdown files. The extension supports taxonomy-driven updates, integrates with external APIs. YAML files are saved at the module level.

Key Features

• Generate YAML metadata for all Markdown files in a selected folder (e.g., includes), including:
  • Unit metadata
  • Knowledge check metadata
  • Module index metadata
• Taxonomy suggestion: Suggest learn taxonomy for your content using Azure AI Search.
• Contributor Guide Chat Panel: Chat with a context-aware assistant for contributor guidance.
• Telemetry: Anonymous usage analytics (feature/command usage, no personal data or file content).

Documentation

📖 Complete User Guide - Step-by-step tutorials, troubleshooting, and detailed feature documentation.

🚀 Quick Start Tutorials - Fast-track tutorials to get started quickly.

Authentication

This extension uses Azure AD authentication via the VS Code authentication API. You must sign in with your Microsoft account to use all features. The extension will prompt you to sign in on activation or when required.

Access tokens are automatically propagated to all API calls (OpenAI, Search, Taxonomy, Contributor Guide).

If you are new to WWL and need access, please contact psot@microsoft.com for assistance.

Getting Started

1. Install the Extension

Download and install the .vsix file:

code --install-extension psotgo-gen-yaml-0.0.1.vsix

2. Configure Extension Settings

Open VS Code Settings (Ctrl+, or Cmd+,), search for "PSOT Go", and set:

• RAG Guide Endpoint: Contributor guide API endpoint
• RAG Taxonomy Endpoint: Taxonomy API endpoint
• RAG GPT Endpoint: LLM API endpoint
• API Base URL: Base URL for PSOT Go API services including telemetry

Or add to your .vscode/settings.json:

{
    "psotgo.ragGuideEndpoint": "https://psotsearchapi.azurewebsites.net/api/learnguide",
    "psotgo.ragTaxonomyEndpoint": "https://psotsearchapi.azurewebsites.net/api/learntaxonomy",
    "psotgo.ragGPTEndpoint": "https://psotsearchapi.azurewebsites.net/api/callgpt",
    "psotgo.apiBaseUrl": "https://psotsearchapi.azurewebsites.net"
}

3. Usage

1. Open a markdown file in your project
2. Right-click and select PSOT Go: Generate YAML Metadata for Markdown Files
3. Select the includes folder containing your Markdown files
4. Generated YAML files will appear in the corresponding module folders

4. Chat Panel & Taxonomy

• Use PSOT Go: Chat with Contributor Guide to open the chat panel for guidance and Q&A.
• Use PSOT Go: Suggest Taxonomy to get taxonomy suggestions for your content (only for files in an includes folder).

Available Commands

• PSOT Go: Generate YAML Metadata for Markdown Files — Main metadata generation
• PSOT Go: Generate KC YAML Only — Generate only knowledge check YAML (appears on knowledge-check files)
• PSOT Go: Parser to Markdown — Convert knowledge-check YAML back to Markdown format
• PSOT Go: Chat with Contributor Guide — Chat panel for contributor guide (dynamic spinner, theme-aware)
• PSOT Go: Suggest Taxonomy — Suggest taxonomy for your content (requires includes/ folder)
• PSOT Go: Provide Feedback / Report a Bug — Open feedback form to report issues or suggestions
• PSOT Go: Sign In — Sign in with your Microsoft account

Telemetry & Usage Analytics

This extension collects anonymous usage data to help improve features and understand active usage. The following information is sent to Azure Application Insights:

• Anonymous user ID (from VS Code)
• Timestamp
• Feature/command used (e.g., chatPanel, generalRefine, etc.)
• Extension version

No personal data or file content is collected.

If you have questions or concerns about telemetry, please contact the maintainer.

Troubleshooting

Sign-in or authentication issues:

• Make sure you are signed in with your Microsoft account (see the sign-in prompt or use the PSOT Go: Sign In command)

YAML files not generating:

• Check the Output panel in VS Code for error messages
• Verify your markdown files are in the correct format
• Ensure you have write permissions to the target folder

Extension commands not appearing:

• Ensure the extension is installed and enabled
• Try reloading VS Code: Ctrl+Shift+P → "Developer: Reload Window"

Packaging the Extension

1. Install vsce:

npm install -g vsce

2. Navigate to your extension folder:

cd <your drive>\content-fine

3. Package your extension:

vsce package