okforest/settings

errorOKForest conventions

.okforest/settings.yaml (spelled .yaml) holds well-formed settings: a name of up to 100 characters, a description of up to 4,000, and ignore globs.

Why

.okforest/settings.yaml holds a tree’s settings for OKForest: a name and description, which OKForest shows for the tree, and ignore globs for markdown files that aren’t concepts. The file and every setting in it are optional, but what’s there must be well formed. Each setting, and the glob syntax, are in Settings.

Example

This file breaks the rule:

.okforest/settings.yaml

name: 42
description: What Acme's teams know about customers, billing, and retention.

okforest validate reports:

.okforest/settings.yaml
  1:1  error    `name` must be text (got a number).  okforest/settings

Fixed:

.okforest/settings.yaml

name: Acme knowledge
description: What Acme's teams know about customers, billing, and retention.