docs

package

v1.15.33 Latest Latest Go to latest Published: Apr 16, 2025 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/act3-ai/data-tool

Links

Open Source Insights

Documentation ¶

Overview ¶

Package docs embeds relevant documentation to be surfaced in the ace-dt CLI.

Index ¶

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

Constants ¶

This section is empty.

Variables ¶

View Source

var BottleDocs embed.FS

BottleDocs contains bottle-related docs

View Source

var ConfigDocs embed.FS

ConfigDocs contains config-related docs

View Source

var GeneralDocs embed.FS

GeneralDocs contains general documentation

View Source

var MirrorDocs embed.FS

MirrorDocs contains mirror-related docs

View Source

var SchemaAssociations = []cmd.SchemaAssociation{
	{
		Definition: "data.act3-ace.io.schema.json",
		FileMatch:  []string{"entry.json", "entry.yaml"},
	},
	{
		Definition: "config.dt.act3-ace.io.schema.json",
		FileMatch:  config.DefaultConfigValidatePath("ace", "dt", "config.yaml"),
	},
}

SchemaAssociations associates JSON Schema definitions with the config files they validate.

Functions ¶

func Embedded ¶

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

Embedded loads and categorizes the embedded documentation for use in the ace-dt CLI.

func Schemas ¶

func Schemas() fs.FS

Schemas returns the embedded schemas for ace-dt.

Types ¶

This section is empty.

Source Files ¶

View all Source files

embed.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL