Skip to content

Commit

Permalink
Merge pull request #484 from gravitational/mmcallister-description-up…
Browse files Browse the repository at this point in the history
…date

Docs: Page descriptions in the style guide
  • Loading branch information
mmcallister authored Jul 10, 2024
2 parents 2f8b35c + ffa0796 commit 229d29d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs-contributors/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ In most cases, how-to guides contain the following sections:

- Frontmatter with a guide title, description, and other information.
The title should be short and identify the subject of the how-to topic in the fewest words possible.
The description should be a sentence that starts with a verb and summarizes the content of the topic.
The description should be a sentence that starts with a verb, summarizes the content of the topic, and ends with a period.
Additional information might include a video banner link, a list of keywords, or an alternate
first-level heading.

Expand Down Expand Up @@ -138,7 +138,7 @@ Conceptual guides typically contain the following sections:

- Frontmatter with a guide title, description, and other information.
The title should be short and identify the subject of the how-to topic in the fewest words possible.
The description should be a sentence that starts with a verb and summarizes the content of the topic.
The description should be a sentence that starts with a verb, summarizes the content of the topic, and ends with a period.
Additional information might include a list of keywords, or an alternate first-level heading.
- Body paragraphs that explain that explain concepts, components, system operations, and context to
help the reader understand what something is, why it's important, and how it works.
Expand All @@ -164,7 +164,7 @@ Reference manuals typically contain the following sections:

- Frontmatter with a guide title, description, and other information.
The title should be short and identify the subject of the how-to topic in the fewest words possible.
The description should be a sentence that starts with a verb and summarizes the content of the topic.
The description should be a sentence that starts with a verb, summarizes the content of the topic, and ends with a period.
Additional information might include a list of keywords.
- One or more introductory paragraphs that explain what information the covers.
- Formatted reference information. The format might resemble a `man` page or API description with a
Expand Down

0 comments on commit 229d29d

Please sign in to comment.