docs

package

v0.4.0 Latest Latest Go to latest Published: Oct 21, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Package docs indexes Markdown/ADR files and links them to code symbols (SYN-20).

This section is empty.

This section is empty.

func Link(opts LinkOptions) (int, error)

Link scans indexed markdown file contents and creates documents edges to code.

func ListDocFiles(root string, ignoreDirNames []string) ([]string, error)

ListDocFiles returns absolute paths of Markdown docs under root.

func ParseFile(absPath, relPath string) (parse.Result, error)

ParseFile maps a markdown file into parse IR (doc + heading nodes).

type LinkOptions struct {
	Root  string
	Store graph.Store
	Repo  string
}

LinkOptions configure the post-index documentation linker.