Help us shape the future of Go! Take the 2026 Go Developer Survey

docs

package
v2.6.1 Latest Latest
Warning

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

Go to latest
Published: Oct 30, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package docs ingests Markdown documentation (ADRs, todos, READMEs) into the same node/edge model as code. Each file becomes one Doc node; each "## " heading becomes a Section node linked by a contains edge. Docs are not Tree-sitter parsed — Markdown structure is heading-based, so a simple chunker suffices. The resulting nodes flow through the same graph + embedding index as code, so semantic search spans code and docs together.

Index

Constants

View Source
const (
	KindDoc     = "Doc"
	KindSection = "Section"
)

Node kinds emitted for documentation.

Variables

This section is empty.

Functions

func Parse

func Parse(path string, source []byte) parser.Result

Parse turns one Markdown file's bytes into a Doc node plus Section nodes. path is the repo-relative file path; it keys the Doc node.

Types

This section is empty.

Jump to

Keyboard shortcuts

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