Skip to content

Commit 6c28535

Browse files
committed
Adding GitHub link exception for regenerated API docs
1 parent 779ec1c commit 6c28535

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -782,7 +782,7 @@ link:http://othersite.com/otherpath[friendly reference text]
782782

783783
IMPORTANT: You must use `link:` before the start of the URL.
784784

785-
IMPORTANT: You cannot link to a repository that is hosted on www.github.com.
785+
IMPORTANT: You cannot link to a repository that is hosted on www.github.com. An exception to this rule is when autogenerated API reference content contains a link to www.github.com.
786786

787787
TIP: If you want to build a link from a URL _without_ changing the text from the actual URL, just print the URL without adding a `[friendly text]` block at the end; it will automatically be rendered as a link.
788788

0 commit comments

Comments
 (0)