Improve formatting for links section of style guide (#31878)

This commit is contained in:
Ethan Palm 2022-12-14 14:19:27 -08:00 коммит произвёл GitHub
Родитель 7b633cef8c
Коммит 7da39b470f
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 7 добавлений и 5 удалений

Просмотреть файл

@ -279,11 +279,13 @@ For plain text, use linebreaks to separate paragraphs in the source (two consecu
## Links
Introduce links consistently using a standard format that clearly indicates where were linking.
For links to other articles in the GitHub docs: `For more information, see "[Page or article title]()."`
For links to another section in the same article: `For more information, see "[Header text]()."`
For links to specific sections in other articles in the GitHub docs: `For more information, see "[Article title]()."`
For links to an article with a specific tool selected: `For more information, see the TOOLNAME documentation in "[ARTICLE TITLE](/PATH/TO/ARTICLE?tool=TOOLNAME).`
For links to external documentation: `For more information, see [Page or article title]() in the X documentation.`
- For links to other articles in the GitHub docs: `For more information, see "[Page or article title]()."`
- For links to another section in the same article: `For more information, see "[Header text]()."`
- For links to specific sections in other articles in the GitHub docs: `For more information, see "[Article title]()."`
- For links to an article with a specific tool selected: `For more information, see the TOOLNAME documentation in "[ARTICLE TITLE](/PATH/TO/ARTICLE?tool=TOOLNAME).`
- For links to external documentation: `For more information, see [Page or article title]() in the X documentation.`
Do not include quotation marks within a hyperlink.
Links should be meaningful and provide high value to the users journey - link out carefully. Move links that are helpful but not necessary to an articles further reading section. Do not repeat the same link more than once in the same article or under the same H2 header.