docs

Documentation

Overview

Package docs provides utilities for embeding documentation.

Index

• Variables
• func Embedded(root *cobra.Command) *embedutil.Documentation
• func Schemas() fs.FS

Variables

var APIs embed.FS

APIs is embedded API documentation.

var GeneralDocumentation embed.FS

GeneralDocumentation is embedded general documentation.

var SchemaAssociations = []cmd.SchemaAssociation{
	{
		Definition: "gnoci.act3-ai.io.schema.json",
	},
}

SchemaAssociations associates the schema file with all config file types.

Functions

func Embedded

func Embedded(root *cobra.Command) *embedutil.Documentation

Embedded is a layout of embedded documentation to surface in the help command and generate in the gendocs command.

func Schemas

func Schemas() fs.FS

Schemas returns the JSON Schema definitions.