Skip to content

Commit

Permalink
chore(#508): add style for page descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
andrablaj committed Feb 14, 2025
1 parent 66f504e commit f28e270
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions content/en/contribute/docs/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,24 @@ This is a sample note.
This is a sample note.
{{% /alert */%}}`

### Page descriptions

Page descriptions show on index pages, and at the top of the individual pages.

Use active and concise language in page descriptions.

| Do | Don't |
|---|---|
|Best practices for configuring CHT applications|This document covers the configuration best practices of forms, tasks, targets, and contact profiles when building your own community health app|

Use sentence case and no punctuation. Avoid multiple sentences.

| Do | Don't |
|---|---|
|Best practices for configuring CHT applications|Best Practices for Configuring CHT Applications|
|Developing and delivering world-class software|Developing and delivering world-class software.|
|The central users of CHT applications|CHWs are the central users of apps built with the Core Framework. CHWs conduct household visits and are responsible for the health of their community.|

### Images

The [image markdown syntax](https://www.markdownguide.org/basic-syntax/#images-1) can be used for images, but if any styling is required use the built-in `figure` shortcode. With the `figure` shortcode [many fields are configurable](https://gohugo.io/content-management/shortcodes/#figure), and the position and size can be responsive with [Bootstrap grid classes](https://getbootstrap.com/docs/4.0/layout/grid/#responsive-classes). You should avoid using the HTML `img` tag in the documentation.
Expand Down

0 comments on commit f28e270

Please sign in to comment.