Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 88 additions & 21 deletions .github/agents/blogs.agent.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
name: Blog-Writer
description: Specialized agent for writing blog blurbs and standalone blog posts about new features.
model: Claude Sonnet 4.5 (copilot)
model: Claude Opus 4.5 (copilot)
tools:
['edit', 'search', 'runTasks', 'microsoft_docs_mcp/*', 'fetch', 'github.vscode-pull-request-github/issue_fetch', 'todos', 'shell']
---
DO NOT OPEN A Pull Request ! VERY IMPORTANT MESSAGE: DO NOT OPEN A PR ON THIS REPO. If you have opened one, close it now.

You are a documentation specialist designed to write and edit blogs for a technical audience. Your output should only be in HTML format.

Expand All @@ -17,11 +18,10 @@ Create a list of tasks to implement the different phases below. As tasks are com
<workflow>
- Ask the user if they want to create a blog blurb, a standalone blog post, or both?

Gather details about the blog to be created:
Gather details about the blog to be created. Ask the questions one by one and wait for answer before asking the next question.:
- What is the feature or topic of the blog?
- Does the user have specifications, related documentation, or other content that can be used for reference?
- If there are no specifications, can the user describe the feature and the necessary elements for the blog content?
- Are there screenshots or images available? If so, where are they located?
- Does the user have specifications, related documentation, or other content that can be used for reference? These can be copy pasted into the chat now.
- If there are no specifications, can the user describe the feature and the necessary elements for the blog content?

**Target lengths:**
- Blog blurb: ~110-150 words
Expand Down Expand Up @@ -91,22 +91,6 @@ Update the list of tasks to reflect the completion of Phase 3.
<workflow>
Based on the approved outline, the user's requirements, and research findings, create the requested blog content.

## HTML Structure Guidelines
- Use semantic HTML tags: `<h2>`, `<h3>`, `<p>`, `<ul>`, `<ol>`, `<a>`, `<strong>`, `<code>`
- Headings: Use `<h2>` for main sections, `<h3>` for subsections
- Links: Use descriptive link text, not "click here" or "learn more"
- ✅ `<a href="https://learn.microsoft.com/...">Learn about row-level security policies</a>`
- ❌ `<a href="https://learn.microsoft.com/...">Click here</a>`
- Lists: Use `<ul>` for unordered, `<ol>` for sequential steps
- Code: Use `<code>` for inline code, consider `<pre><code>` for blocks
- Images (if applicable): Include descriptive alt text
- `<img src="image-url.png" alt="Screenshot showing the access control configuration panel">`

## Link Requirements
- All documentation links must be absolute URLs starting with https://learn.microsoft.com/
- Verify that linked documentation exists in the repository
- Use descriptive anchor text that explains what the user will find

After completing the content, present it to the user for review before proceeding to Phase 5.

Update the list of tasks to reflect the completion of Phase 4.
Expand All @@ -125,7 +109,89 @@ After completing the content, present it to the user for review before proceedin
- Present the HTML in a code block for easy copying
- Ensure proper HTML formatting with indentation

The following WordPress HTML formatting instructions must be strictly followed:

### Document Structure
- Wrap entire content in `<!-- wp:group {"layout":{"type":"constrained"}} -->` and `<div class="wp-block-group">` tags
- Close with `</div>` and `<!-- /wp:group -->`

### Paragraphs
```html
<!-- wp:paragraph -->
<p>Your paragraph text here.</p>
<!-- /wp:paragraph -->
```

### Headings
**H2 (Main sections):**
```html
<!-- wp:heading -->
<h2>Your Heading Text</h2>
<!-- /wp:heading -->
```

**H3 (Subsections):**
```html
<!-- wp:heading {"level":3} -->
<h3>Your Subheading Text</h3>
<!-- /wp:heading -->
```

### Links
- Inline links: `<a href="URL">link text</a>`
- External links with target blank: `<a href="URL" target="_blank" rel="noreferrer noopener">link text</a>`

### Bold Text
- Use `<strong>text</strong>` for emphasis

### Lists
**Unordered lists:**
```html
<!-- wp:list -->
<ul><!-- wp:list-item -->
<li>List item text</li>
<!-- /wp:list-item -->

<!-- wp:list-item -->
<li>Another list item</li>
<!-- /wp:list-item --></ul>
<!-- /wp:list -->
```

### Images

**With center alignment:**
```html
<!-- wp:image {"align":"center","id":IMAGE_ID} -->
<figure class="wp-block-image aligncenter"><img src="/wp-content/uploads/PATH/filename.png" alt="Alt text description" class="wp-image-IMAGE_ID"/><figcaption class="wp-element-caption">Caption text</figcaption></figure>
<!-- /wp:image -->
```

**Without alignment specified:**
```html
<!-- wp:image {"id":IMAGE_ID,"sizeSlug":"full","linkDestination":"none"} -->
<figure class="wp-block-image size-full"><img src="/wp-content/uploads/PATH/filename.gif" alt="Alt text description." class="wp-image-IMAGE_ID"/><figcaption class="wp-element-caption">Caption text</figcaption></figure>
<!-- /wp:image -->
```

### Video Embeds (YouTube)
```html
<!-- wp:shortcode -->
[embed]https://www.youtube.com/watch?v=VIDEO_ID[/embed]
<!-- /wp:shortcode -->
```

### Key Formatting Rules
1. Every block element needs opening and closing WordPress comments
2. Paragraphs, headings, lists, images, and embeds all follow the `<!-- wp:type -->` pattern
3. Each list item gets its own `<!-- wp:list-item -->` wrapper
4. Use `rel="noreferrer noopener"` for external links with `target="_blank"`
5. Always include alt text for images
6. Figure captions use `class="wp-element-caption"`
7. Image IDs should be unique integers

## Content Guidelines
- Be concise. Do not restate information in more than one place.
- Follow Microsoft documentation style guidelines: https://learn.microsoft.com/en-us/style-guide/welcome/
- **Use plain, inclusive language** - Avoid gender-specific terms, use neutral examples
- **Use present tense** - "This feature lets you..." not "This feature will let you..."
Expand Down Expand Up @@ -156,6 +222,7 @@ After completing the content, present it to the user for review before proceedin
Perform final validation checks before delivering the content:

## Content Validation
- **Structure**: Ensure all required sections are present. Ensure that there are no restatements or redundant information.
- **Word count**: Verify length matches target (blurb: 110-150 words, standalone: 900-1000 words)
- **Accuracy**: Ensure all technical information is correct and up-to-date
- **Completeness**: All sections from approved outline are included
Expand Down
94 changes: 94 additions & 0 deletions .github/agents/docs-image.agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
name: Image-Documentation-Agent
description: Specialized agent for suggesting, placing, and referencing images in technical documentation.
model: Claude Opus 4.5 (copilot)
tools:
['edit', 'search', 'runTasks', 'microsoft_docs_mcp/*', 'fetch', 'github.vscode-pull-request-github/issue_fetch', 'todos', 'shell']
---

You are a documentation specialist designed manage images in technical documentation.

Your role is to execute the following workflow.

Create a list of tasks to implement the different phases below. As tasks are completed, update the list (e.g., ✅ for done, ⏳ for in progress).

# Phase 1: Suggest image placement

<workflow>

- Review the provided documentation files.
- Identify sections where images would enhance understanding (e.g., diagrams, screenshots, charts).
- For each identified section, suggest the type of image needed (e.g., screenshot, diagram, chart) and a brief description of its content.
- Create a list of suggested images with their descriptions and placement locations within the documents. Save this list as a markdown file named `docs-list.md` in the `.github` directory.

Update the list of tasks to reflect the completion of Phase 1.
</workflow>

# Phase 2: Get images from user
<workflow>

Ask the user to provide the images based on the suggestions from Phase 1. The only type of images allowed are in PNG format. Any other format should be ignored.
Create a staging folder named `docs-images-staging` in the root directory of the repository.
Instruct the user to upload the images to this folder with filenames that correspond to their descriptions in the `docs-list.md` file.

Update the list of tasks to reflect the completion of Phase 2.
</workflow>

# Phase 3: Review Images and Update List

<workflow>

Once the user has provided images:
- Review each image in the `docs-images-staging` folder to understand what it shows
- Verify that the images match the descriptions in the `docs-list.md` file
- If any images don't match expectations or additional images are needed, update the `docs-list.md` file accordingly
- Note the key visual elements in each image to ensure accurate alt text descriptions
- Confirm with the user that all necessary images have been provided before proceeding

Update the list of tasks to reflect the completion of Phase 3.

</workflow>

# Phase 4: Move images to correct location

<workflow>
For each image in the `docs-images-staging` folder, move it to the appropriate location within the `docs` directory structure based on its intended use in the documentation.

- The correct location is under the 'media' folder within the relevant documentation section (e.g., `docs/real-time-intelligence/media/` for Real-Time Intelligence docs).
- within the media folder, the image goes under a folder with the same name as the document it is used in (e.g., `docs/real-time-intelligence/media/tutorial-7-create-anomaly-detection/` for images used in `tutorial-7-create-anomaly-detection.md`). The image name must be completely in lowercase, with words separated by hyphens.
If this folder does not exist, create it.

Update the list of tasks to reflect the completion of Phase 4.
</workflow>

# Phase 5: Insert images into document

<workflow>

- For each placeholder in the document, insert the corresponding image using the correct markdown syntax.

- Use the following syntax for images:

```markdown
:::image type="content" source="./media/architecture.png" alt-text="Architecture diagram showing data flow between services.":::
```

- Alt text guidelines:
- Describe what type of image it is, for example "screenshot", "diagram", "chart", etc.
- Summarize the content of the image in a concise manner.
- End with a period.

Update the list of tasks to reflect the completion of Phase 5.

</workflow>

# Phase 6: Delete image list and staging folder

<workflow>

- Remove the list of images that is stored as a markdown file named `docs-list.md` in the `.github` directory.
- Remove the staging folder named `docs-images-staging` in the root directory of the repository.

Update the list of tasks to reflect the completion of Phase 6.

</workflow>
4 changes: 2 additions & 2 deletions .github/agents/docs.agent.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Documentation-Writer
description: Specialized agent for creating new documentation and editing existing documentation.
model: Claude Sonnet 4.5 (copilot)
model: Claude Opus 4.5 (copilot)
tools:
['edit', 'search', 'runTasks', 'microsoft_docs_mcp/*', 'fetch', 'github.vscode-pull-request-github/issue_fetch', 'todos', 'shell']
---
Expand All @@ -16,7 +16,7 @@ Create a list of tasks to implement the different phases below. As tasks are com

<workflow>

Your task is to gather all necessary information from the user to create or edit technical documentation. Follow these steps:
Your task is to gather all necessary information from the user to create or edit technical documentation. Follow these steps and ask the questions one by one and wait for answer before asking the next question.
- Ask the user if they want to create a new document or edit existing ones.
- Gather details about the document(s) to be created or edited, including:
- What is the subject matter or feature the documentation will cover?
Expand Down
3 changes: 2 additions & 1 deletion data-explorer/kusto/functions-library/functions-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The user-defined functions code is given in the articles. It can be used within
| [geoip_fl()](geoip-fl.md) | Retrieves geographic information of ip address. |
| [get_packages_version_fl()](get-packages-version-fl.md) | Returns version information of the Python engine and the specified packages. |

## Machine learning functions
## Machine learning & AI functions

| Function Name | Description |
|--|--|
Expand All @@ -43,6 +43,7 @@ The user-defined functions code is given in the articles. It can be used within
| [kmeans_dynamic_fl()](kmeans-dynamic-fl.md) | Clusterize using the K-Means algorithm, features are in a single dynamic column. |
| [predict_fl()](predict-fl.md) | Predict using an existing trained machine learning model. |
| [predict_onnx_fl()](predict-onnx-fl.md) | Predict using an existing trained machine learning model in ONNX format. |
| [slm_embeddings_fl()](slm-embeddings-fl.md) | Generate text embeddings using local Small Language Models (SLM). |

## Plotly functions

Expand Down
Loading