Skip to content

Commit 606720b

Browse files
subatoiCopilotsupergranularCopilot
authored
Integrating EDI guidance into the conceptual type (#60443)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Thom Wong <101249231+supergranular@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 2221ccc commit 606720b

3 files changed

Lines changed: 20 additions & 13 deletions

File tree

content/contributing/style-guide-and-content-model/conceptual-content-type.md renamed to content/contributing/style-guide-and-content-model/concepts-content-type.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,39 @@
11
---
2-
title: Conceptual content type
2+
title: Concepts content type
33
intro: People most often use conceptual content when they are learning about something new to them.
4+
category:
5+
- Follow the style guide and content model
46
versions:
57
fpt: '*'
68
ghec: '*'
79
ghes: '*'
8-
category:
9-
- Follow the style guide and content model
10+
redirect_from:
11+
- /contributing/style-guide-and-content-model/conceptual-content-type
1012
---
1113

1214
Conceptual content helps people understand a feature or topic by providing a clear, high-level overview, explanation of how the feature or topic can help them on their journey, and context like use cases or examples.
1315

14-
We create conceptual articles and conceptual sections within other articles. Most major products, features, or subjects have their own conceptual article.
16+
We create concepts articles and conceptual sections within other articles. Most major products, features, or subjects have their own concepts article.
17+
18+
## Deciding between an article or a section
19+
20+
How-tos or tutorials can have 1-2 brief introductory sentences before the steps. If more explanation beyond a couple of sentences is needed, that’s when we should consider whether it merits a spot in a concepts article.
21+
22+
However, we should be selective. Not every concept or “About X” section needs its own article. Generally this comes down to how much information will be useful to the user that we need to include.
1523

1624
## How to write conceptual content
1725

18-
For the conceptual content template, see [AUTOTITLE](/contributing/writing-for-github-docs/templates#conceptual-article-template).
26+
For the conceptual content template, see [AUTOTITLE](/contributing/writing-for-github-docs/templates#concepts-article-template).
1927

2028
* Describe in plain language what the feature, product, or topic is.
2129
* Describe its purpose and why it’s useful to the reader.
2230
* Share use cases or examples.
23-
* If relevant, describe how the feature or topic works (be mindful of audience and the right location for deep dives into technical details).
24-
* Highlight any details the reader needs to know to use the feature.
25-
* Include next steps for getting started with the feature (whether through further reading links or content within the article itself).
2631

2732
## Titles for conceptual content
2833

29-
* Conceptual articles or headers of conceptual sections start with "About [subject]”.
34+
Short titles for articles should be one word or a noun phrase. If the articles appear under Concepts in the sidebar avoid using "About", unless the article appears under a heading of the same name. Ex: "Coding agent" and "About coding agent".
35+
36+
Headers of conceptual sections in articles start with "About [subject]”.
3037
* Use a noun to describe the subject.
3138
* Use: "About {% data variables.product.prodname_code_scanning %}"
3239
* Avoid: "About scanning your code for vulnerabilities"

content/contributing/style-guide-and-content-model/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ children:
99
- /style-guide
1010
- /about-the-content-model
1111
- /contents-of-a-github-docs-article
12-
- /conceptual-content-type
12+
- /concepts-content-type
1313
- /reference-content-type
1414
- /how-to-content-type
1515
- /troubleshooting-content-type

content/contributing/writing-for-github-docs/templates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ category:
99
- Follow the style guide and content model
1010
---
1111

12-
## Conceptual article template
12+
## Concepts article template
1313

14-
Use the content model for full instructions and examples on how to write conceptual content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/conceptual-content-type).
14+
Use the content model for full instructions and examples on how to write conceptual content. For more information, see [AUTOTITLE](/contributing/style-guide-and-content-model/concepts-content-type).
1515

1616
<!-- markdownlint-disable search-replace -->
1717

@@ -27,7 +27,7 @@ versions:
2727
---
2828

2929
{% comment %}
30-
- Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model#conceptual to write this article.
30+
- Follow the guidelines in https://docs.github.com/contributing/writing-for-github-docs/content-model to write this article.
3131
- Great intros give readers a quick understanding of what's in the article, so they can tell whether it's relevant to them before moving ahead. For more tips, see https://docs.github.com/contributing/writing-for-github-docs/content-model
3232
- For product callout info, see https://github.com/github/docs/tree/main/content#product
3333
- For product version instructions, see https://github.com/github/docs/tree/main/content#versioning

0 commit comments

Comments
 (0)