Skip to content

Commit ac15b5c

Browse files
committed
updates to git ignore
1 parent 3103317 commit ac15b5c

File tree

7 files changed

+1019
-4
lines changed

7 files changed

+1019
-4
lines changed

.github/copilot-instructions.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Copilot Instructions
2+
3+
This file provides central guidance for GitHub Copilot in this repository.
4+
5+
This documentation repository contains Microsoft's technical documentation for application development using Microsoft Azure AI Foundry (and other products) that publishes to Microsoft Learn.
6+
7+
8+
## Referenced Instruction Files
9+
10+
• .github/instructions/foundry-branding.instructions.md
11+
• .github/instructions/dev-focused.instructions.md
12+
13+
## Disclosure
14+
15+
For any Markdown files modified by AI, always disclose that they were created with the assistance of AI. Add the following frontmatter key/value pair:
16+
17+
ai-usage: ai-assisted
18+
19+
## Content Verification Rules
20+
21+
- DO NOT invent or fabricate technical details, API parameters, or service capabilities.
22+
- DO NOT create fictional code examples or imaginary features.
23+
- DO NOT hallucinate or assume facts not found in official or credible documentation.
24+
- ALWAYS check specification documents and official references before making suggestions.
25+
- When a recommendation is based on another instruction file or linked source, cite it inline (for example: “(Source: edit_instructions.md)”).
26+
- If required information is missing or unclear, insert a placeholder with `[TO VERIFY]`—do not guess.
27+
28+
## Writing Style
29+
30+
Follow Microsoft Writing Style Guide (https://learn.microsoft.com/en-us/style-guide/welcome/) with these specifics:
31+
32+
### Voice and Tone
33+
34+
• Active voice, second person addressing reader directly.
35+
• Conversational tone with contractions.
36+
• Present tense for instructions/descriptions.
37+
• Imperative mood for instructions ("Call the method" not "You should call the method").
38+
• Use "might" instead of "may" for possibility.
39+
• Use "can" instead of "may" for permissible actions.
40+
• Avoid "we"/"our" referring to documentation authors or product teams.
41+
42+
### Pattern compliance
43+
44+
- Articles should comply with the pattern for the ms.topic type listed in the metadata
45+
- `how-to-guide` - refer to .github/patterns/How-to-template.md
46+
- `quickstart` - refer to .github/patterns/Quickstart-template.md
47+
- `tutorial` - refer to .github/patterns/Tutorial-template.md
48+
49+
Instructions for the pattern are contained in comments in the referenced file.
50+
51+
## Structure and Format
52+
53+
- Use sentence case for titles and headings; avoid gerunds in titles.
54+
- Keep paragraphs short (1–3 sentences).
55+
- Break up or rewrite long sentences (>25 words).
56+
- Use the Oxford comma in lists.
57+
- Number ordered list items using `1.` for each line (Markdown auto-numbers).
58+
- List items should be complete sentences when longer than a short phrase; end with a period if a sentence.
59+
- Avoid “etc.” or “and so on.” Use “for example” with a concrete subset or provide the full list.
60+
- Use “for example” instead of “e.g.”; “that is” instead of “i.e.”.
61+
- Don’t stack headings without intervening explanatory text.
62+
- Keep conceptual explanation separate from procedural steps.
63+
- Reserve troubleshooting for a clearly labeled section when needed.
64+
65+
## Formatting Conventions
66+
67+
- Bold: UI labels and visible button or menu text.
68+
- Code style (backticks): file names, folders, inline code, commands, class and method names, non-localizable tokens.
69+
- Use relative links for repo-local files.
70+
- Use angle brackets around raw URLs only when the plain URL must be shown.
71+
- Present tense only; rewrite future tense (“will create”) to present (“creates” / “creates a resource”).
72+
- Prefer gender-neutral language; avoid idioms and metaphors.
73+
- Tables only when they improve scan-ability (parameters, comparisons).
74+
75+
## File Naming
76+
77+
- New Markdown files: lowercase, hyphen-separated.
78+
- Omit filler words (the, a, an, of) unless needed for clarity.
79+
- Keep names task- or concept-focused (for example: `monitor-model-performance.md`).
80+
81+
82+
## Referencing sources
83+
84+
When basing content on:
85+
- Internal instruction files: cite the filename inline.
86+
- External docs (public): use a relative or official Microsoft Learn link.
87+
If uncertain about a claim, mark it `[TO VERIFY]`.
88+
89+
## Change boundaries
90+
91+
- Don’t alter original meaning unless the task explicitly requests it.
92+
- Safe edits: clarity, consistency, formatting, style compliance, verified corrections.
93+
94+
95+
## General guidance
96+
97+
- Always re-check `.github/instructions/` before large edits.
98+
- Keep diffs focused; avoid opportunistic large-scale refactors unless requested.
99+
- Consolidate repetitive phrasing where possible for readability.
100+
- Align with current product branding from `foundry-branding.instructions.md`.
101+
Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
---
2+
title: #Required; Keep the title body to 60-65 chars max including spaces and brand
3+
description: #Required; Keep the description within 100- and 165-characters including spaces
4+
author: #Required; your GitHub user alias, with correct capitalization
5+
ms.author: #Required; microsoft alias of author
6+
ms.service: #Required; use the name-string related to slug in ms.product/ms.service
7+
ms.topic: concept-article #Required; leave this attribute/value as-is.
8+
ms.date: #Required; mm/dd/yyyy format.
9+
10+
#CustomerIntent: As a <type of user>, I want <what?> so that <why?>.
11+
---
12+
13+
<!--
14+
Remove all the comments in this template before you sign-off or merge to the main branch.
15+
16+
This template provides the basic structure of a Concept article pattern. See the [instructions - Concept](../level4/article-concept.md) in the pattern library.
17+
18+
You can provide feedback about this template at: https://aka.ms/patterns-feedback
19+
20+
Concept is an article pattern that defines what something is or explains an abstract idea.
21+
22+
There are several situations that might call for writing a Concept article, including:
23+
24+
* If there's a new idea that's central to a service or product, that idea must be explained so that customers understand the value of the service or product as it relates to their circumstances. A good recent example is the concept of containerization or the concept of scalability.
25+
* If there's optional information or explanations that are common to several Tutorials or How-to guides, this information can be consolidated and single-sourced in a full-bodied Concept article for you to reference.
26+
* If a service or product is extensible, advanced users might modify it to better suit their application. It's better that advanced users fully understand the reasoning behind the design choices and everything else "under the hood" so that their variants are more robust, thereby improving their experience.
27+
28+
-->
29+
30+
<!-- 1. H1
31+
-----------------------------------------------------------------------------
32+
33+
Required. Set expectations for what the content covers, so customers know the content meets their needs. The H1 should NOT begin with a verb.
34+
35+
Reflect the concept that undergirds an action, not the action itself. The H1 must start with:
36+
37+
* "\<noun phrase\> concept(s)", or
38+
* "What is \<noun\>?", or
39+
* "\<noun\> overview"
40+
41+
Concept articles are primarily distinguished by what they aren't:
42+
43+
* They aren't procedural articles. They don't show how to complete a task.
44+
* They don't have specific end states, other than conveying an underlying idea, and don't have concrete, sequential actions for the user to take.
45+
46+
One clear sign of a procedural article would be the use of a numbered list. With rare exception, numbered lists shouldn't appear in Concept articles.
47+
48+
-->
49+
50+
# [\<noun phrase\> concept(s)]
51+
TODO: Add your heading
52+
53+
<!-- 2. Introductory paragraph
54+
----------------------------------------------------------
55+
56+
Required. Lead with a light intro that describes what the article covers. Answer the fundamental "why would I want to know this?" question. Keep it short.
57+
58+
* Answer the fundamental "Why do I want this knowledge?" question.
59+
* Don't start the article with a bunch of notes or caveats.
60+
* Don't link away from the article in the introduction.
61+
* For definitive concepts, it's better to lead with a sentence in the form, "X is a (type of) Y that does Z."
62+
63+
-->
64+
65+
[Introductory paragraph]
66+
TODO: Add your introductory paragraph
67+
68+
<!-- 3. Prerequisites --------------------------------------------------------------------
69+
70+
Optional: Make **Prerequisites** your first H2 in the article. Use clear and unambiguous
71+
language and use a unordered list format.
72+
73+
-->
74+
75+
## Prerequisites
76+
TODO: [List the prerequisites if appropriate]
77+
78+
<!-- 4. H2s (Article body)
79+
--------------------------------------------------------------------
80+
81+
Required: In a series of H2 sections, the article body should discuss the ideas that explain how "X is a (type of) Y that does Z":
82+
83+
* Give each H2 a heading that sets expectations for the content that follows.
84+
* Follow the H2 headings with a sentence about how the section contributes to the whole.
85+
* Describe the concept's critical features in the context of defining what it is.
86+
* Provide an example of how it's used where, how it fits into the context, or what it does. If it's complex and new to the user, show at least two examples.
87+
* Provide a non-example if contrasting it will make it clearer to the user what the concept is.
88+
* Images, code blocks, or other graphical elements come after the text block it illustrates.
89+
* Don't number H2s.
90+
91+
-->
92+
93+
## [Section 1 heading]
94+
TODO: add your content
95+
96+
## [Section 2 heading]
97+
TODO: add your content
98+
99+
## [Section n heading]
100+
TODO: add your content
101+
102+
<!-- 5. Next step/Related content ------------------------------------------------------------------------
103+
104+
Optional: You have two options for manually curated links in this pattern: Next step and Related content. You don't have to use either, but don't use both.
105+
- For Next step, provide one link to the next step in a sequence. Use the blue box format
106+
- For Related content provide 1-3 links. Include some context so the customer can determine why they would click the link. Add a context sentence for the following links.
107+
108+
-->
109+
110+
## Next step
111+
112+
TODO: Add your next step link(s)
113+
114+
> [!div class="nextstepaction"]
115+
> [Write concepts](article-concept.md)
116+
117+
<!-- OR -->
118+
119+
## Related content
120+
121+
TODO: Add your next step link(s)
122+
123+
- [Write concepts](article-concept.md)
124+
125+
<!--
126+
Remove all the comments in this template before you sign-off or merge to the main branch.
127+
-->
128+
129+
130+
<!-- 6. Next step/Related content ------------------------------------------------------------------------
131+
132+
Optional: You have two options for manually curated links in this pattern: Next step and Related
133+
content. You don't have to use either, but don't use both. For Next step, provide one link to the
134+
next step in a sequence. Use the blue box format For Related content provide 1-3 links. Include some
135+
context so the customer can determine why they would click the link. Add a context sentence for the
136+
following links.
137+
138+
-->
139+
140+
## Next step
141+
TODO: Add your next step link(s)
142+
> [!div class="nextstepaction"]
143+
> [Write concepts](article-concept.md)
144+
145+
<!-- OR -->
146+
147+
## Related content
148+
TODO: Add your next step link(s)
149+
- [Write concepts](article-concept.md)
150+
151+
<!--
152+
Remove all the comments in this template before you sign-off or merge to the
153+
main branch.
154+
155+
-->

0 commit comments

Comments
 (0)