Skip to content

Commit d1fd07b

Browse files
authored
Merge pull request #71592 from skrthomas/API-github-link-exception
Adding GitHub link exception for regenerated API docs
2 parents 51ae93a + 6c28535 commit d1fd07b

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
@@ -867,7 +867,7 @@ link:http://othersite.com/otherpath[friendly reference text]
867867

868868
IMPORTANT: You must use `link:` before the start of the URL.
869869

870-
IMPORTANT: You cannot link to a repository that is hosted on www.github.com.
870+
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.
871871

872872
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.
873873

0 commit comments

Comments
 (0)