Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/contributing/style-guide-and-content-model/about-topics
What part(s) of the article would you like to see updated?
The first link in https://docs.github.com/en/contributing/style-guide-and-content-model/about-topics points to https://github.com/github/docs/tree/main/content#topics. It should point to https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics.
However, there is also scope to clarify what topics are and how they are defined in Markdown. The first paragraph of the article could be rewritten to explain that an article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter - i.e. the metadata at the top of an article's Markdown file.
It would be more helpful to provide information about where to define the topics for an article, directly within the "About topics" article (with an example of a topics entry in the frontmatter), rather than linking away to other resources in the opening paragraph.
Additional information
No response
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/contributing/style-guide-and-content-model/about-topics
What part(s) of the article would you like to see updated?
The first link in https://docs.github.com/en/contributing/style-guide-and-content-model/about-topics points to https://github.com/github/docs/tree/main/content#topics. It should point to https://docs.github.com/en/contributing/writing-for-github-docs/using-yaml-frontmatter#topics.
However, there is also scope to clarify what topics are and how they are defined in Markdown. The first paragraph of the article could be rewritten to explain that an article can be defined as being relevant to one or more topics by having those topics listed in the article's frontmatter - i.e. the metadata at the top of an article's Markdown file.
It would be more helpful to provide information about where to define the topics for an article, directly within the "About topics" article (with an example of a topics entry in the frontmatter), rather than linking away to other resources in the opening paragraph.
Additional information
No response