docs

README

Configuration Documentation

1. core.toml & chains-*.toml files are sources of truth for config docs. Update/add documentation here.

2. CONFIG.md is generated from (1) by config.GenerateDocs() via docs/main.go. Do not edit this file. Run make config-docs from the root of the repo.

See example.toml and example.md for a minimal example.

Documentation

Index

• func CoreDefaults() (c toml.Core)
• func GenerateConfig() (string, error)
• func GenerateSecrets() (string, error)

Functions

func CoreDefaults

func CoreDefaults() (c toml.Core)

func GenerateConfig

func GenerateConfig() (string, error)

GenerateConfig returns MarkDown documentation generated from core.toml & chains-*.toml.

func GenerateSecrets

func GenerateSecrets() (string, error)

GenerateSecrets returns MarkDown documentation generated from secrets.toml.