README.md

DigitalOcean Vale Package

This repository contains a Vale-compatible implementation of the DigitalOcean Style Guide.

Getting Started

To get started, add the package to your configuration file (as shown below) and then run vale sync.

StylesPath = styles # Use your normal style path here.
Packages = https://github.com/digitalocean/vale-package/releases/latest/download/do-vale.zip

See Vale's documentation on packages for more information.

Included Components

• The DigitalOcean style implements the DigitalOcean style guide.
• The PDocs style implements the DigitalOcean Product Docs style guide.
• The DigitalOcean vocab implements DigitalOcean-specific terminology.
• The Technical vocab implements more general technical terminology.

There are also a significant number of words defined in .github/vale/ignore, including notably a set of words with spelling suggestions which we want to catch with one of the package rules rather than with the less helpful spellchecker.