docs

package

v0.38.0 Latest Latest Go to latest Published: Oct 26, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

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

Repository

github.com/goxang/rig

Links

Open Source Insights

Documentation ¶

Overview ¶

Package docs carries rig's reference into the binary: rig docs, and the rig_docs MCP tool.

Index ¶

Variables
func Sections(doc, query string) (found string, headings []string)

Constants ¶

This section is empty.

Variables ¶

View Source

var FS embed.FS

View Source

var Names = []string{"config", "guide", "cli", "plugins", "protocol", "contracts", "views", "security", "design", "manifests"}

Names are the docs FS holds, the default first.

Functions ¶

func Sections ¶ added in v0.13.0

func Sections(doc, query string) (found string, headings []string)

Sections returns the ## / ### sections of a doc holding every word of query (case ignored), each under its heading, and the doc's headings for when none does.

Types ¶

This section is empty.

Source Files ¶

View all Source files

docs.go

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