doc

package
v0.3.2 Latest Latest
Warning

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

Go to latest
Published: Aug 29, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var DocCmd = &cobra.Command{
	Use:   "doc",
	Short: "Documentation management commands",
	Long: `Manage documentation tracking, creation, and verification for CANARY requirements.

Documentation tracking ensures that each CANARY token references up-to-date documentation
files. The system uses SHA256 hashing to detect staleness and keep docs in sync with code.`,
	Example: `  # Create documentation from template
  canary doc create CBIN-105 --type user --output docs/user/authentication.md

  # Update documentation hash after editing
  canary doc update CBIN-105

  # Check documentation status
  canary doc status CBIN-105
  canary doc status --all`,
}

CANARY: REQ=ENG-4315; FEATURE="DocParentCommand"; ASPECT=CLI; STATUS=IMPL; UPDATED=2025-10-16

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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