Skip to content

docs: add llms.txt - #116

Merged
kolkov merged 1 commit into
mainfrom
docs/llms-txt
Nov 6, 2026
Merged

kolkov merged 1 commit into
mainfrom
docs/llms-txt

Conversation

@kolkov

@kolkov kolkov commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

goffi had no llms.txt. This adds one in the llmstxt.org format: a paragraph on what goffi does and where it runs, the usage rules people most often get wrong (avalue holds pointers to the values, Go memory must stay reachable during the call, type limits, #72 and #22), and links to the API reference, docs, examples and the projects that use it. The README documentation table links to it.

Every URL in the file resolves (checked with curl, all 200).

A short llmstxt.org summary of what goffi does, the usage rules that most often go wrong (avalue holds pointers to the values, Go memory must stay reachable during the call, type limits, the Linux/FreeBSD cgo linking issue #72) and links to the API reference, docs, examples and the projects that use it. Linked from the README documentation table.
@kolkov kolkov added the type: docs Documentation only label Nov 6, 2026
@codecov

codecov Bot commented Nov 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@kolkov
kolkov merged commit 3cdee77 into main Nov 6, 2026
49 checks passed
@kolkov
kolkov deleted the docs/llms-txt branch November 6, 2026 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant