Skip to content

Commit 41c07df

Browse files
authored
Merge pull request #66 from microsoft/sync-public-docs
Merge public docs into private repo
2 parents ad49211 + b6ddf33 commit 41c07df

File tree

403 files changed

+3368
-1854
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

403 files changed

+3368
-1854
lines changed

.github/instructions/docs-writing.instructions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
applyTo: '**/*.md'
2+
applyTo: 'docs/**/*.md, api/**/*.md, remote/**/*.md'
33
---
44
# Documentation Writing Instructions
55

@@ -108,3 +108,4 @@ These are our documentation writing style guidelines.
108108
* Avoid latin abbreviations like "e.g.". Use "for example" instead.
109109
* Use the verb "to enable" instead "to allow" unless you're referring to permissions.
110110
* Follow the terms and capitalization guidelines in #fetch [VS Code docs wiki](https://github.com/microsoft/vscode-docs/wiki/VS-Code-glossary)
111+
* Don't use the following terms: "simply", "just", "easy", "obviously", "of course", "etc.", "delve", "crucial", "utilize", "leverage", "prior to", "in order to", "harness".

.github/prompts/askvscode.prompt.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2+
description: Ask questions about VS Code
23
mode: agent
34
model: Claude Sonnet 4
4-
tools: ['codebase', 'usages', 'vscodeAPI', 'githubRepo', 'search']
5+
tools: ['usages', 'vscodeAPI', 'githubRepo', 'search']
56
---
67
You are an expert in answering questions about Visual Studio Code, its features, and how to use it effectively. Explain how specific features work, give examples of usage scenarios.
78

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
11
---
22
mode: agent
33
tools: ['search', 'vscodeAPI', 'problems', 'fetch', 'githubRepo', 'todos']
4-
description: You are a technical writer reviewing a VS Code release notes for clarity, conciseness, and adherence to the writing style guidelines.
4+
description: Review release notes
55
---
6-
Review the article for clarity, conciseness, and adherence to our [release notes writing style guidelines](../instructions/release-notes-writing.instructions.md).
6+
You are a technical writer specialized in VS Code and release note reviews. Perform a review of the provided release notes, focusing on clarity, conciseness, and adherence to [release notes writing style guidelines](../instructions/release-notes-writing.instructions.md).
77

8-
Provide a concise summary of the key changes and improvements highlighted in the release notes.
9-
Provide concrete and practical suggestions for improvement.
8+
Focus on the following elements:
9+
10+
* Titles are descriptive, concise, and avoid unnecessary jargon.
11+
* Feature updates describe the change, its benefit, and any relevant context.
12+
* Feature updates are grouped under appropriate headings (e.g., "Chat", "Editor Experience", "Terminal").
13+
* If settings are mentioned in a section, start the section with "**Setting**: `setting(setting.name)`".
14+
* Feature updates follow the general [docs writing guidelines](../instructions/docs-writing.instructions.md).
15+
* Skip the Notable Fixes and Thank You sections.
16+
17+
Outcome:
18+
19+
* Markdown list of suggested improvements
20+
* Provide specific line numbers for each suggestion
21+
* Provide the current text and the suggested revision
22+
* Suggestions should be specific and actionable.

.vscode/extensions/doc-assistant/dist/extension.js

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5067,6 +5067,9 @@ async function getReleaseFeatures(milestoneName) {
50675067
});
50685068
for (const edge of result.search.edges) {
50695069
const issue = toIssue(edge);
5070+
if (!issue) {
5071+
continue;
5072+
}
50705073
if (issue.labels.includes('*duplicate')) {
50715074
continue;
50725075
}
@@ -5095,8 +5098,12 @@ async function getReleaseFeaturesWithTestPlanItems(milestoneName, onTestPlan, gq
50955098
after: null
50965099
});
50975100
for (const edge of result.search.edges) {
5101+
const issue = toIssue(edge);
5102+
if (!issue) {
5103+
continue;
5104+
}
50985105
const releaseFeature = {
5099-
...toIssue(edge),
5106+
...issue,
51005107
related: []
51015108
};
51025109
releaseFeature.related.push(...await getIssuesFiledAgainst(edge.node.number, gqlClient));
@@ -5115,14 +5122,28 @@ async function getIssuesFiledAgainst(testPlanItem, gqlClient) {
51155122
repositoryQuery: `repo:microsoft/vscode is:closed Testing ${testPlanItem}`,
51165123
after: null
51175124
});
5118-
return result.search.edges.map(edge => toIssue(edge));
5125+
const issues = [];
5126+
for (const edge of result.search.edges) {
5127+
const issue = toIssue(edge);
5128+
if (!issue) {
5129+
continue;
5130+
}
5131+
issues.push(issue);
5132+
}
5133+
return issues;
51195134
}
51205135
catch (error) {
51215136
console.error('Error fetching issues:', error);
51225137
throw error;
51235138
}
51245139
}
51255140
function toIssue(edge) {
5141+
if (!edge.node) {
5142+
return undefined;
5143+
}
5144+
if (!edge.node.number) {
5145+
return undefined;
5146+
}
51265147
return {
51275148
number: edge.node.number,
51285149
summary: edge.node.title,

.vscode/extensions/doc-assistant/dist/extension.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.vscode/extensions/doc-assistant/src/tools/queries.ts

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,14 @@ export async function getReleaseFeatures(milestoneName: string): Promise<Release
9090

9191
for (const edge of result.search.edges) {
9292
const issue = toIssue(edge);
93+
if (!issue) {
94+
continue;
95+
}
9396
if (issue.labels.includes('*duplicate')) {
94-
continue
97+
continue;
9598
}
9699
if (issue.labels.includes('*out-of-scope')) {
97-
continue
100+
continue;
98101
}
99102
if (issue.labels.includes('on-testplan')) {
100103
onTestPlan.push(issue);
@@ -123,8 +126,12 @@ async function getReleaseFeaturesWithTestPlanItems(milestoneName: string, onTest
123126
});
124127

125128
for (const edge of result.search.edges) {
129+
const issue = toIssue(edge);
130+
if (!issue) {
131+
continue;
132+
}
126133
const releaseFeature: ReleaseFeature = {
127-
...toIssue(edge),
134+
...issue,
128135
related: []
129136
};
130137
releaseFeature.related.push(...await getIssuesFiledAgainst(edge.node.number, gqlClient));
@@ -146,15 +153,29 @@ async function getIssuesFiledAgainst(testPlanItem: string, gqlClient: GraphqlCli
146153
after: null
147154
});
148155

149-
return result.search.edges.map(edge => toIssue(edge));
156+
const issues: Issue[] = [];
157+
for (const edge of result.search.edges) {
158+
const issue = toIssue(edge);
159+
if (!issue) {
160+
continue;
161+
}
162+
issues.push(issue);
163+
}
164+
return issues;
150165

151166
} catch (error) {
152167
console.error('Error fetching issues:', error);
153168
throw error;
154169
}
155170
}
156171

157-
function toIssue(edge: any): Issue {
172+
function toIssue(edge: any): Issue | undefined {
173+
if (!edge.node) {
174+
return undefined;
175+
}
176+
if (!edge.node.number) {
177+
return undefined;
178+
}
158179
return {
159180
number: edge.node.number,
160181
summary: edge.node.title,

api/advanced-topics/extension-host.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# DO NOT TOUCH — Managed by doc writer
33
ContentId: 106AA11C-DB26-493A-9E3C-16F513B2AEC8
4-
DateApproved: 09/11/2025
4+
DateApproved: 10/09/2025
55

66
# Summarize the whole topic in less than 300 characters for SEO purpose
77
MetaDescription: The Visual Studio Code Extension Host is responsible for managing extensions and ensuring the stability and performance of Visual Studio Code.

api/advanced-topics/remote-extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
ContentId: 5c708951-e566-42db-9d97-e9715d95cdd1
3-
DateApproved: 09/11/2025
3+
DateApproved: 10/09/2025
44

55
# Summarize the whole topic in less than 300 characters for SEO purpose
66
MetaDescription: A guide to adding Visual Studio Code Remote Development and GitHub Codespaces support to extensions

api/advanced-topics/tslint-eslint-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
ContentId: f00c4913-58e3-4a61-aa42-e769c3430906
3-
DateApproved: 09/11/2025
3+
DateApproved: 10/09/2025
44

55
# Summarize the whole topic in less than 300 characters for SEO purpose
66
MetaDescription: A guide to migrating extension projects from the TSLint linter to ESLint.

api/advanced-topics/using-proposed-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
# DO NOT TOUCH — Managed by doc writer
33
ContentId: f4d4e9e0-8901-405c-aaf5-faa16c32588b
4-
DateApproved: 09/11/2025
4+
DateApproved: 10/09/2025
55

66
# Summarize the whole topic in less than 300 characters for SEO purpose
77
MetaDescription: Use Visual Studio Code's Proposed API

0 commit comments

Comments
 (0)