agentguides

package
v0.14.2 Latest Latest
Warning

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

Go to latest
Published: Jul 23, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package agentguides embeds and loads the agent workflow guides that docent serves through `jira agent` and `jira guide`. The guides follow the Agent Guide Standard: one Markdown file per workflow, six fixed sections, frontmatter routing metadata. Content lives here; delivery, validation, and export live in docent.

Index

Constants

View Source
const ContractVersion = "3.0.0"

ContractVersion is the semver of the agent-facing contract: the command tree, envelope, exit codes, and guide semantics published by `jira agent schema` and stamped on the guide index. Bump major for a breaking change to the envelope, exit codes, or an existing flag/field; minor for additive surface; patch for wording-only changes. Independent of the binary version. The move from the hand-rolled surface to docent (new schema shape, new guide set) is the 2.x → 3.0.0 break.

Variables

This section is empty.

Functions

func FS

func FS() (fs.FS, error)

FS returns the guides directory as its own filesystem root, the view docenttest.Validate expects (the raw embed FS is rooted one level up).

func Load

func Load() (*docent.GuideSet, error)

Load parses and validates the embedded guide set.

Types

This section is empty.

Jump to

Keyboard shortcuts

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