From 8945d7c7c15ba0697b2d7a847794cf3a86cefa56 Mon Sep 17 00:00:00 2001
From: Pete Bacon Darwin <pete@bacondarwin.com>
Date: Sat, 13 Feb 2021 13:56:33 +0000
Subject: [PATCH] build(docs-infra): add a link to `usage notes` from
 `description` (#40835)

The "Usage Notes" section is often at the bottom of a long page of content
which can make it difficult to discover. This commit adds a link at the
end of the "Description" if there is a "Usage Notes" section on the page.
This link should help the reader to discover that there is more information
available further down the page.

This is basically a marginal fix. The longer term fix should be to
consider what content goes in which sections and how they should
be laid out on the page.

See #40753

PR Close #40835
---
 aio/tools/transforms/templates/api/includes/description.html | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/aio/tools/transforms/templates/api/includes/description.html b/aio/tools/transforms/templates/api/includes/description.html
index d5545c06e7..22cede4edd 100644
--- a/aio/tools/transforms/templates/api/includes/description.html
+++ b/aio/tools/transforms/templates/api/includes/description.html
@@ -2,5 +2,7 @@
 <section class="description">
   <h2>Description</h2>
   {$ doc.description | trimBlankLines | marked $}
+  {% if doc.usageNotes %}<p>Further information available in the <a href="#usage-notes">Usage Notes</a>...</p>{%
+  endif %}
 </section>
 {% endif %}
\ No newline at end of file