Skip to content

Yaml Schema Style Documentation for Numbast Configs #194

@isVoid

Description

@isVoid

Currently the only place where we can point our user to the available items in Numbast config is here:

.

A better documentation + validation is via YAML schema: https://www.asdf-format.org/projects/asdf-standard/en/1.0.1/schemas/yaml_schema.html

The benefit include:

  • Code-is-documentation
  • Tooling support (strictyaml can perform input validation on load)
  • IDE support (vscode.yaml plugin supports dev-time warning/error message by associating with a schema)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions