Skip to content

Commit

Permalink
Merge pull request #6033 from EnterpriseDB/docs/style_guide
Browse files Browse the repository at this point in the history
Style guide: full stop in frontmatter descriptions
  • Loading branch information
gvasquezvargas authored Sep 25, 2024
2 parents 113820b + 40166c9 commit 5e64931
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion advocacy_docs/community/contributing/styleguide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Included in this guide:
* 13 [Dates](#dates)
* 14 [Terminology considerations](#terminology-considerations)
* 15 [Trademark symbols](#trademark-symbols)
* 16 [Frontmatter](#frontmatter)

## Language and tone

Expand Down Expand Up @@ -656,4 +657,20 @@ Examples: EDB Postgres® AI, EDB Postgres® Analytics, EDB Postgres® Machine Le
For other trademarks, the documentation site already includes a general disclaimer at the footer of every page called "Trademark" which links to https://www.enterprisedb.com/trademarks.
Contrary to the specifications on [Trademarks](https://www.enterprisedb.com/trademarks), don't include the symbol in page titles,
because the symbol can affect how search engines index and find pages.
because the symbol can affect how search engines index and find pages.
## Frontmatter
The frontmatter is located at the top of every Markdown page and allows you to specify metadata and options in YAML language. Frontmatter lets you control how a page renders.
Ensure your page, at minimum, includes a `title` and `description` as metadata. It can include other metadata such as `navTitle`, `deepToC`, and so on.
```yaml
---
title: Working with the repo
description: Step-by-step instructions to install and use the docs repo.
---
```
!!!note
Ensure the `description` has a final stop (period), even if it isn't a full grammatical sentence. Descriptions are used to dynamically build a summary for each section in `index` pages. Since all descriptions are then displayed next to each other, add a full stop to ensure visual consistency.

1 comment on commit 5e64931

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.