digital-asset / digital-asset/cn-quickstart

Uplift documentation to comply with Vale rules

Open
#245 0 comments 0 reactions 1 assignee Claimed by @TheChronicMonster View on GitHub
Dominant language
Haskell
Stars
49
Forks
40
Avg merge
4d 11h
Merged PRs (30d)
5

Description

## Background

#242 added Vale tooling to the repository to ensure documentation consistency. It is currently disabled from preventing merging, so it is for information only.

To see the scale of what is outstanding in Vale:

```bash
$ cd sdk
$ make vale-errors | wc -l
make: *** [Makefile:56: run-vale] Error 1
203
$ make vale-suggestions | wc -l
make: *** [Makefile:56: run-vale] Error 1
806
```

## Task

* Review rule output and make it comply with Vale rules.
* Enable Vale rule enforcement in CI, such that Value errors are not permitted.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.