Skip to content

Commit 1c69432

Browse files
CBID2nguyenalex836
andauthored
fix: revise link and improve information about topics in the contributing docs (github#34491)
Signed-off-by: Christine <[email protected]> Co-authored-by: Alex Nguyen <[email protected]>
1 parent 45360f5 commit 1c69432

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

content/contributing/style-guide-and-content-model/about-topics.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,19 @@ versions:
66
feature: 'contributing'
77
---
88

9-
Topics are used to filter articles and are searchable across the {% data variables.product.prodname_docs %} site. For some layouts, such as landing pages or guides, people can select which articles are displayed by filtering topics. Use these guidelines to help choose which topics to add to an article's frontmatter. For more information on adding topics to an article see, "[Topics](https://github.com/github/docs/tree/main/content#topics)" and for a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js).
9+
Topics are used to filter articles and are searchable across the {% data variables.product.prodname_docs %} site. For some layouts, such as landing pages or guides, people can select which articles are displayed by filtering topics. Also, an article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter. For example:
10+
11+
```yaml
12+
---
13+
title: "Managing branches in your repository"
14+
topics:
15+
- "GitHub"
16+
- "Git"
17+
- "Repositories"
18+
---
19+
```
20+
21+
For more information on adding topics to an article see, "[AUTOTITLE](/contributing/writing-for-github-docs/using-yaml-frontmatter#topics)". For a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js).
1022

1123
## Topics for all content types
1224

0 commit comments

Comments
 (0)