docgen

package
v0.6.1 Latest Latest
Warning

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

 Go to latest Published: Nov 3, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package docgen renders the CLI (cobra tree) and policy (JSON Schema) reference pages for the docs site. Output is deterministic: sorted, no timestamps.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CLI 

func CLI(root *cobra.Command, dir string) (int, error)

CLI writes one page per command under dir (index.md for the root) and returns the number of pages. Existing *.md files in dir are removed first so renamed commands leave nothing stale.

func Policy 

func Policy(schemaDir, dir string) (int, error)

Policy renders one page per schemas/*.schema.json into dir plus index.md and returns the number of pages written.

Types

This section is empty.

Source Files

View all Source files

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.