Skip to content

Commit d9acbd8

Browse files
authored
Create copilot-instructions.md file (#55839)
1 parent f32fc8c commit d9acbd8

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

.github/copilot-instructions.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
This documentation repository consists mainly of content written in Markdown format. These files are converted into HTML for displaying on a website. Most Markdown files become a single article on the documentation site. Other files contain reusable content which is inserted into multiple articles. The repository also contains YAML files (e.g. for variable text), image files, JavaScript/TypeScript files, etc.
2+
3+
### Using variables
4+
5+
Within Markdown files, with the exception of the `title` field in the metadata at the start of a file, always use the Liquid syntax variables rather than text if a variable has been defined for that text. For example:
6+
7+
| Use this variable | Don't use this text | File where variable is defined |
8+
| --- | --- | --- |
9+
| `{% data variables.product.prodname_dotcom %}` | GitHub | data/variables/product.yml |
10+
| `{% data variables.product.prodname_ghe_server %}` | GitHub Enterprise Server | data/variables/product.yml |
11+
| `{% data variables.product.prodname_copilot_short %}` | Copilot | data/variables/product.yml |
12+
| `{% data variables.product.prodname_copilot %}` | GitHub Copilot | data/variables/product.yml |
13+
| `{% data variables.copilot.copilot_code-review_short %}` | Copilot code review | data/variables/copilot.yml |
14+
| `{% data variables.enterprise.prodname_managed_user %}` | managed user account | data/variables/enterprise.yml |
15+
| `{% data variables.code-scanning.codeql_workflow %}` | CodeQL analysis workflow | data/variables/code-scanning.yml |
16+
17+
There are many more variables. These are stored in various YAML files within the `data/variables` directory.

0 commit comments

Comments
 (0)