Merge pull request #27286 from michelle-purcell/QDOCS-50

Add guidance for creating a Quarkus doc abstract

docs/src/main/asciidoc/doc-create-tutorial.adoc

@@ -62,9 +62,9 @@ They should be able to determine if they want to engage with the content.
 
 [source,asciidoc]
 ----
-In this tutorial, we will create an application that uses unique annotations from the experimental acme extension to define two endpoints:
-a simple Http endpoint and an endpoint that emits Server-Sent Events (SSE).
-We will also use Quarkus dev mode for iterative development and test.
+Create an application that uses unique annotations from the experimental acme extension to define two endpoints:
+a simple HTTP endpoint and an endpoint that emits server-sent events (SSE).
+We will also use Quarkus dev mode for iterative development and testing.
 ----
 
 .Document Preview

docs/src/main/asciidoc/doc-reference.adoc

@@ -112,8 +112,16 @@ The following links provide background on Asciidoc syntax and general convention
 :semantic-line-breaks: footnote:smbl[Rhodes, B. Semantic Linefeeds. https://rhodesmill.org/brandon/2012/one-sentence-per-line/]
 
 Text in paragraphs, lists, and tables should be broken into pieces that are easier to review{semantic-line-breaks}.
-Start a new line at the end of each sentence, and
-split sentences themselves at natural breaks between clauses.
+Start a new line at the end of each sentence, and split sentences themselves at natural breaks between clauses.
+
+=== Abstracts (preamble)
+
+For optimum findability, add a short description using user-oriented keywords to summarize the document's purpose, task, and intent in no more than three sentences.
+
+[IMPORTANT]
+====
+The first sentence of the abstract must explain the value and some benefit of the content in less than 26 words because this automatically displays on the link:https://quarkus.io/guides/[Quarkus guides homepage].
+====
 
 === Automatic Table of Contents (TOC)