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

Docs Writing Style Guide / Best Practices #1792

Closed
wants to merge 2 commits into from
Closed
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
60 changes: 60 additions & 0 deletions docs/home/writing-best-practices.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
id: docs-best-practices
title: Writing Docs - Best Practices
pagination_label: Writing Best Practices
sidebar_label: Writing Best Practices
description: Writing Docs - Best Practices
image: https://docs.helium.com/img/link-image.png
slug: /home/docs-best-practices
---

# Style Guide for Helium Docs (docs.helium.com)

This is a collection of agreed upon dos and don'ts for pages on Helium Docs.

## [Category 1]

[Placeholder]

## [Category 2]

[Placeholder]

## Technical terms

### Governance related

#### "Locking / Delegating" vs. "Staking"

- When talking about token lock-up and delegation of tokens, use the specific terms "locking" and
"delegating" where applicable
- Avoid referring to any of those solely as "staking"

| Recommended | Example |
| ----------- | --------------------------------------------------------------------------------------------------------- |
| ✔️ | _"To earn MOBILE token rewards: (1.) Lock HNT (2.) Delegate the veHNT position to the Mobile Subnetwork"_ |
| ❌ | _"To earn MOBILE token rewards: (1.) Lock HNT (2.) Delegate the veHNT position to the Mobile Subnetwork"_ |

## Miscellaneous

### Links

Do:      Name linked things
Don't:  Connect the link to a linked thing with a "click here" or "here".

_Examples:_
_Do:       Visit [Google](www.google.com) to learn more._
_Don't:   [Click here](www.google.com) to go to Google._

_Do:       Find the
[Disk91 ChipStack service on GitHub](https://github.com/disk91/helium-chirpstack-community)_
_Don't:   Find the service on GitHub
[here](https://github.com/disk91/helium-chirpstack-community)_

## [Category xx]

[Placeholder]

## [Category xx]

[Placeholder]