Skip to content

Commit

Permalink
Add guidance for creating a Quarkus doc abstract
Browse files Browse the repository at this point in the history
  • Loading branch information
michelle-purcell committed Aug 15, 2022
1 parent 6011998 commit 5b7fccc
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/src/main/asciidoc/doc-reference.adoc
Expand Up @@ -82,8 +82,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)

Expand Down

0 comments on commit 5b7fccc

Please sign in to comment.