docs

package
v1.13.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 6, 2023 License: MIT Imports: 9 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

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.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
cmd
generate
Docs prints core node documentation and/or a list of errors.
 Docs prints core node documentation and/or a list of errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.