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.
Click to show internal directories.
Click to hide internal directories.