Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(#508): add style for page descriptions #1773

Merged
merged 2 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/building/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Concepts"
weight: 13
description: >
Basic concepts that will help you understand how CHT applications are built
Basic concepts about how CHT applications are built
aliases:
- /apps/concepts/
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/concepts/access.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Accessing CHT Apps"
linkTitle: "Access"
weight: 1
description: >
Starting up your digital health apps
Starting up a digital health app

aliases:
- /apps/concepts/access
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/concepts/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Navigating CHT Apps"
linkTitle: "Navigation"
weight: 2
description: >
Browsing your digital health apps
Browsing a digital health app
aliases:
- /apps/concepts/navigation
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/condition-cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Condition Cards
linkTitle: Condition Cards
weight: 6
description: >
Building CHT application condition cards
Building CHT condition cards
relatedContent: >
building/contact-management
building/contact-summary/contact-summary-templated#condition-cards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "CHT User Management tool"
linkTitle: User management tool
weight: 5
description: >
How to use and configure a user management tool for your CHT project.
How to use and configure a user management tool for a CHT project
relatedContent: >
building/contact-management/contact-and-users-1
building/guides/data/users-bulk-load
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Building Contact Summary
linkTitle: Building
weight: 1
description: >
Building CHT application contact summary
Building CHT Application contact summary
relatedContent: >
building/contact-management#contact-summary
building/contact-summary/contact-summary-templated#contact-summary
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/features/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Features of CHT Applications"
linkTitle: "Features"
weight: 15
description: >
Overview of features of CHT applications built with CHT Core
Overview of features of CHT Applications built with CHT Core
aliases:
- /apps/features/
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/features/messaging/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Messaging
weight: 5
description: >
Messaging for Care Coordination, Alerts, and Notifications
Messaging for care coordination, alerts, and notifications
relatedContent: >
building/reference/app-settings/schedules
building/guides/messaging
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/features/reports/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Reports
weight: 6
description: >
Reports for Data & Report Management
Reports for data & report management
relatedContent: >
building/reference/app-settings/patient_reports
building/guides/data/invalid-reports
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Quick Guides for Implementers"
linkTitle: "Quick Guides"
weight: 15
description: >
These quick guides address focused CHT app development topics
Focused CHT app development guides
aliases:
- /apps/guides/
---
2 changes: 1 addition & 1 deletion content/en/building/guides/android/publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Publishing"
linkTitle: "Publishing"
weight: 4
description: >
Instructions for Publishing Android Apps
Instructions for publishing Android Apps
relatedContent: >
contribute/code/android/releasing
building/guides/android/branding
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/guides/performance/purging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Purging"
linkTitle: "Purging"
weight:
description: >
Remove unneeded documents from offline users devices.
Remove unneeded documents from offline users devices
keywords:
relatedContent: >
design/personas/chw-janet
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/guides/performance/replication.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "CouchDB replication"
linkTitle: "Replication"
weight:
description: >
Settings for downloading copies of data onto a user's device.
Settings for downloading copies of data onto a user's device
keywords:
relatedContent: >
building/reference/app-settings/replication_depth
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/guides/security/securing-android.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Securing Android Devices"
linkTitle: "Securing Android"
weight:
description: >
How to secure android devices used in deployments
How to secure Android devices used in deployments
relatedContent: >
building/guides/debugging/replicating-production-data-locally
hosting/3.x/ssl-cert-install
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Prerequisites for App Development"
linkTitle: "Prerequisites"
weight: 1
description: >
Tools and background skills that are helpful for developing CHT apps
Tools and skills needed for developing CHT Applications
relatedContent: >
building/local-setup
aliases:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Training Cards Configuration"
linkTitle: "Configuring"
weight: 15
description: >
Deploy in-app training cards for remote training.
Deploying in-app training cards for remote training
keyword: training
relatedContent: >
building/training/training-cards
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Step-by-Step Tutorials"
linkTitle: "Tutorials"
weight: 15
description: >
A growing collection of thorough step-by-step tutorials for developing and deploying digital health apps with the Community Health Toolkit.
A collection of step-by-step tutorials for developing and deploying digital health apps with the CHT
aliases:
- /apps/tutorials/
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/application-graphics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Configuring CHT Application Graphics"
linkTitle: Branding
weight: 14
description: >
Configuring CHT Application Graphics
Configuring CHT Application graphics
relatedContent: >
building/features/admin
design/interface/icons
Expand Down
2 changes: 1 addition & 1 deletion content/en/building/tutorials/couch2pg-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Local Couch2pg Setup"
linkTitle: Couch2pg Setup
weight: 21
description: >
Setting up a Couch2pg service to download data from CouchDB to Postgres Database
Setting up a Couch2pg service to download data from CouchDB to Postgres database
relatedContent: >
building/local-setup
aliases:
Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/code/repository-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "CHT Product Repository Checklist"
linkTitle: "Repository Checklist"
weight: 8
description: >
Checklist to consider when creating CHT Product repositories under Medic's GitHub organization account
Checklist to consider when creating CHT Product repositories
---

## Repository Creation Checklist
Expand Down
2 changes: 1 addition & 1 deletion content/en/contribute/code/static-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Static Analysis"
linkTitle: "Static Analysis"
weight: 11
description: >
Guidelines for static analysis of CHT code.
Guidelines for static analysis of CHT code
---

## eslint
Expand Down
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
2 changes: 1 addition & 1 deletion content/en/contribute/tech-radar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "CHT Technology Radars"
linkTitle: "Tech radar"
weight: 6
description: >
CHT Technology Radars for Contributors and Implementers
CHT Technology Radars for contributors and implementers
---

It is essential for a development toolkit such as the Community Health Toolkit to constantly improve and keep track with the latest useful innovations. It is important to openly look for innovations and new technologies and to question established technologies and methods every now and then.
Expand Down
2 changes: 1 addition & 1 deletion content/en/core/overview/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Architecture of CHT Instances"
linkTitle: "CHT Core"
weight: 1
description: >
The different pieces of a CHT project, how they interact, and what they're used for
Overview of CHT projects components and interactions
relatedContent: >
core/overview/watchdog
core/overview/cht-sync
Expand Down
2 changes: 1 addition & 1 deletion content/en/core/overview/data-flows-for-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Data Flows for Analytics"
linkTitle: "Data Flows"
weight: 3
description: >
An overview of data flows in the CHT for analytics, impact monitoring, and data science
Overview of data flows in the CHT for analytics, impact monitoring, and data science
relatedContent: >
building/guides/data
building/guides/database
Expand Down
2 changes: 1 addition & 1 deletion content/en/core/overview/offline-first.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Offline-First in the CHT"
linkTitle: "Offline-First"
weight: 2
description: >
An overview of what Offline-First means, why the CHT uses it, and how to contribute code that uses it.
Overview of Offline-First in the context of the CHT
---

## Introduction
Expand Down
2 changes: 1 addition & 1 deletion content/en/core/overview/pwa.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Installation as a Progressive Web App"
linkTitle: "Progressive Web App"
weight: 2
description: >
What it means that the CHT Core web application is a Progressive Web App.
What it means that the CHT Core web application is a Progressive Web App
---

## What is a Progressive Web App (PWA)?
Expand Down
2 changes: 1 addition & 1 deletion content/en/core/overview/transitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Sentinel Transitions"
linkTitle: "Sentinel Transitions"
weight: 4
description: >
Overview of Transitions, JavaScript code that runs server-side when database documents change
Overview of transitions and database documents change
relatedContent: >
building/reference/app-settings/transitions
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/design/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Configuration Best Practices"
linkTitle: "Best Practices"
weight: 5
description: >
Best Practices for configuring CHT Applications
Best practices for configuring CHT Applications
aliases:
- /design/best-practices/
---
Expand Down
2 changes: 1 addition & 1 deletion content/en/design/interface/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Interface"
linkTitle: "Interface"
weight: 2
description: >
Interface principles to help shaping the design of the CHT and providing support in effective implementation
Interface principles to design the CHT and support effective implementation
---

The purpose of this guide is to document the standard aspects of the core framework and allow designers and developers to focus on solving challenges, rather than reinventing interface elements that are already in use.
2 changes: 1 addition & 1 deletion content/en/design/personas/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "User Personas"
linkTitle: "Personas"
weight: 1
description: >
The "typical" users of CHT Apps across diverse contexts
The "typical" users of CHT Applications across diverse contexts
---

User personas give you a common understanding of who you are serving, particularly when working across diverse contexts. Your global personas are based on "typical" users, knowing that some variation is present in different settings.
Expand Down
2 changes: 1 addition & 1 deletion content/en/exploring/covid-rdt-reference-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "COVID-19 Testing with Rapid Diagnostic Tests"
linkTitle: "COVID-19 Testing"
weight:
description: >
CHT example application that uses a third party app to capture the result of a Rapid Diagnostic Test.
CHT example application that uses a third party app to capture the result of a Rapid Diagnostic Test
relatedContent: >
building/forms/app/#android-app-launcher
building/forms/app/#cht-xform-widgets
Expand Down
2 changes: 1 addition & 1 deletion content/en/exploring/interoperability.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Loss to Follow Up"
linkTitle: "Loss to Follow Up"
weight:
description: >
Generating patients with missed follow-up appointments between the CHT and requesting system
Handling patients with missed follow-up appointments between the CHT and other health systems
keywords: Loss to Follow Up
relatedContent: >
building/interoperability
Expand Down
2 changes: 1 addition & 1 deletion content/en/exploring/learning-care.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Learning and Care"
linkTitle: "Learning & Care"
weight:
description: >
An integration built to pilot the integrated workflows focused on CHW remote learning and care support for COVID-19.
An integration built to pilot the integrated workflows focused on CHW remote learning and care support for COVID-19
keywords: oppia
relatedContent: >
building/integrations/oppia
Expand Down
2 changes: 1 addition & 1 deletion content/en/exploring/pharmacovigilance-reference-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Pharmacovigilance Reference app"
linkTitle: "Pharmacovigilance"
weight:
description: >
CHT example application that supports pharmacovigilance in a community setting.
CHT example application that supports pharmacovigilance in a community setting
aliases:
- /apps/examples/pharmacovigilance-reference-app
- /building/examples/pharmacovigilance-reference-app
Expand Down
2 changes: 1 addition & 1 deletion content/en/exploring/stock-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Stock Monitoring"
linkTitle: "Stock Monitoring"
weight:
description: >
Guidance on design and development of stock monitoring workflows.
Guidance on design and development of stock monitoring workflows
keywords: stock monitoring
aliases:
- /apps/examples/stock-monitoring
Expand Down
4 changes: 2 additions & 2 deletions content/en/exploring/supervisor-reference-app.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Reference Application for CHW Supervision and Performance Management"
title: "CHW Supervision and Performance Management Reference App "
linkTitle: "Supervision & Performance Management"
weight:
description: >
A reference app for CHW supervisors to support performance management of CHWs using a mobile app.
A reference app for CHW supervisors to support performance management of CHWs
relatedContent: >
building/concepts
building/features/supervision
Expand Down
2 changes: 1 addition & 1 deletion content/en/exploring/training.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Remote Onboarding and Training"
linkTitle: "Remote Training"
weight:
description: >
App and care workflow training using remote capabilities.
App and care workflow training using remote capabilities
keywords: training onboarding
relatedContent: >
building/reference/app-settings/token_login/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Migrating from couch2pg to CHT Sync"
weight: 4
linkTitle: "couch2pg to CHT Sync"
description: >
Instructions on migrating from couch2pg to CHT Sync for data synchronization and analytics.
Instructions on migrating from couch2pg to CHT Sync for data synchronization and analytics
relatedContent: >
core/overview/cht-sync
core/overview/data-flows-for-analytics/
Expand Down
3 changes: 2 additions & 1 deletion content/en/hosting/costs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@
title: "Hosting Costs"
linkTitle: "Hosting Costs"
weight: 2
description: >
A guide for calculating CHT hosting costs
aliases:

---


## Cost per CHT per Month

In a production environment, the CHT costs USD$0.10 per active user per month to run. What exactly does this mean? Let's dive into some specifics which importantly cover what is include and excluded and how these costs can vary with each deployment.
Expand Down