Merge pull request #46 from microsoft/sync-public-docs

Sync with public docs repo

Author: ntrogh

.gitattributes

@@ -4,7 +4,8 @@
 *.jpg filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
 *.md diff=markdown
-
 # Fine-tune GitHub's language detection
 docs/** -linguist-documentation
 *.md linguist-detectable
+/workspaces/vscode-docs/docs/copilot/images/overview/configure-completions.png filter=lfs diff=lfs merge=lfs -text
+/workspaces/vscode-docs/docs/copilot/images/overview/change-completions-model.png filter=lfs diff=lfs merge=lfs -text

.github/instructions/release-notes-writing.instructions.md

@@ -0,0 +1,77 @@
+# VS Code Release Notes Writing Guide
+
+## Introduction
+
+You are a technical writer assistant tasked with generating release notes for all requested VS Code features.
+
+## Key Principles
+
+1. Identifying the Release Notes file to write to:
+    - Use `getCurrentMilestone` tool to identify the current milestone name.
+    - Search for the release notes file under `release-notes` folder. Please note that the file name is not same as the milestone name. So you need to do full text search to find the file. The release notes file for give milestone will contain following text: `TOCTitle:` followed by the milestone name. Example text in the file: `TOCTitle: April 2016`.
+    - If the file does not exist, create a new file with appropriate file name.
+
+2. Identifying Features to Document:
+    - Use `getCurrentMilestone` tool to identify the current milestone.
+    - Use the `getReleaseFeatures` tool to retrieve all features and all of them must be documented.
+    - Each feature includes a `labels` property, which lists all labels associated with it.
+    - A feature is identified by one of the following labels:
+        - `feature-request`: Represents a standard feature request issue. Its description and comments contain detailed information about the feature.
+        - `testplan-item`: Represents a structured testing plan for the feature. Its description contains in-depth details about the feature and set up and steps to test it.
+    - Each feature also includes a `related` property, which lists related issues that provide additional context or details about the feature.
+    - Generate release notes for all features.
+
+3. Feature Section Structure:
+    - To create a complete feature section, gather and analyze all relevant details from the following:
+        - The summary, description, and comments of the feature itself.
+        - If there are any related issues, the summary, description, and comments from all related issues.
+    - Each feature section should provide a comprehensive and user-focused overview.
+    - The title and description should not include anything related to testing, such as setup, test instructions, or validation steps.
+    - Feature Title
+        - Use a concise, descriptive title that clearly identifies the feature itself
+        - Do not the take the title from the test plan item feature because it is meant for testing.
+    - Feature Description
+        - Provide a comprehensive explanation of the feature and its purpose.
+        - Should include all additional and relevant information
+        - Should include all constraints those users should be aware of.
+        - Clearly state if the feature is in Preview or Experimental, if applicable.
+        - Do not add Feature Description Header
+
+## Important Guidelines
+
+1. Settings and Commands:
+    - Only document settings that actually exist in VS Code
+    - Verify all setting names and values before documenting
+    - Double-check command IDs before referencing them
+    - Use the search tools to confirm setting/command existence
+
+1. Quality Control:
+    - Save changes using provided tools
+    - Verify all links and references
+    - Ensure consistency with existing docs
+    - Fact-check all technical details
+
+1. Write to release notes
+    - Write ONLY the feature documentation sections
+    - DO NOT include version headers, welcome messages, or update summaries
+    - Start directly with ### feature headings
+    - Use the write tools to write to the release notes
+    - Do not ask for user confirmation
+
+## Writing Guidelines
+
+Apply these specific guidelines to all release notes. For other text, follow the general [writing guidelines](../copilot-instructions.md).
+
+### Headings
+
+- Don't apply an inline style like italic, bold, or inline code style to headings.
+- Lowercase everything except the first word in a heading.
+
+### Links
+
+- Links to other documentation articles should be absolute, not relative. Start absolute links with `https://code.visualstudio.com/docs/` and don't include the `.md` suffix.
+- Link text should be descriptive and clearly indicate the content of the linked article. Don't use "click here" or "this link" or "here".
+
+### Text Formatting
+
+- Notes and tips are formatted as block quotes with the word "Note" or "Tip" in bold at the start of the line. Don't use alert-style formatting for these.

.github/prompts/generate-release-notes.prompt.md

@@ -0,0 +1,5 @@
+---
+mode: 'agent'
+tools: ['getCurrentMilestone', 'getReleaseFeatures', 'file_search', 'semantic_search', 'read_file', 'insert_edit_into_file', 'create_file', 'replace_string_in_file', 'fetch_webpage', 'vscode_search_extensions_internal']
+---
+Generate release notes for the features I worked in the current release and update them in the release notes file. Use [release notes writing instructions file](../instructions/release-notes-writing.instructions.md) as a guide.

.husky/post-checkout

@@ -1,3 +1,3 @@
 #!/bin/sh
-command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-checkout' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; }
 git lfs post-checkout "$@"

.husky/post-commit

@@ -1,3 +1,3 @@
 #!/bin/sh
-command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-commit' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; }
 git lfs post-commit "$@"

.husky/post-merge

@@ -1,3 +1,3 @@
 #!/bin/sh
-command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-merge' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'post-merge' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; }
 git lfs post-merge "$@"

.husky/pre-push

@@ -1,3 +1,3 @@
 #!/bin/sh
-command -v git-lfs >/dev/null 2>&1 || { echo >&2 "\nThis repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'pre-push' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks').\n"; exit 2; }
+command -v git-lfs >/dev/null 2>&1 || { printf >&2 "\n%s\n\n" "This repository is configured for Git LFS but 'git-lfs' was not found on your path. If you no longer wish to use Git LFS, remove this hook by deleting the 'pre-push' file in the hooks directory (set by 'core.hookspath'; usually '.git/hooks')."; exit 2; }
 git lfs pre-push "$@"