From 782bcc4a34ed4b10ff6c5cbe1e8a3bb38013d93f Mon Sep 17 00:00:00 2001 From: Xavier Noria Date: Thu, 13 May 2021 16:31:27 +0200 Subject: [PATCH] Update guides/source/api_documentation_guidelines.md Co-authored-by: Eileen M. Uchitelle --- guides/source/api_documentation_guidelines.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/guides/source/api_documentation_guidelines.md b/guides/source/api_documentation_guidelines.md index 17f08e02bb..fa6c4bd143 100644 --- a/guides/source/api_documentation_guidelines.md +++ b/guides/source/api_documentation_guidelines.md @@ -33,7 +33,7 @@ directives](https://ruby.github.io/rdoc/RDoc/Parser/Ruby.html). Links ----- -Rails API documentation are not meant to be viewed on GitHub and so links should use the RDoc [`link`](https://ruby.github.io/rdoc/RDoc/Markup.html#class-RDoc::Markup-label-Links) markup relative to the current API. +Rails API documentation are not meant to be viewed on GitHub and therefore links should use the RDoc [`link`](https://ruby.github.io/rdoc/RDoc/Markup.html#class-RDoc::Markup-label-Links) markup relative to the current API. This is due to differences between GitHub Markdown and the generated RDoc that is published at [api.rubyonrails.org](https://api.rubyonrails.org) and [edgeapi.rubyonrails.org](https://edgeapi.rubyonrails.org).