Skip to content

docs: refresh llms.txt, add AGENTS.md, fix stale public docs - #38

Merged
kolkov merged 6 commits into
mainfrom
docs/llms-refresh
Nov 11, 2026
Merged

kolkov merged 6 commits into
mainfrom
docs/llms-refresh

Conversation

@kolkov

@kolkov kolkov commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

Refreshes the agent-facing and public documentation against the current code.

  • llms.txt rewritten for the current API: plain vs typed handlers, nine built-in middleware including Timeout, OpenAPI schemas inferred from generic handlers, current plugins and examples, measured coverage and benchmarks. The quick-start snippets compile; the TOC anchors were checked.
  • AGENTS.md added as the short entry point for AI agents (it was missing).
  • Public docs corrected: README says GitHub Flow instead of git-flow and quotes one measured performance example instead of fixed ns/op claims; ROADMAP current-version markers; CONTRIBUTING tree (drops the empty internal/validation/ leftover and adds timeout.go); the OpenTelemetry README uses ListenAndServeWithShutdown; examples/10 badge is Go 1.27 and the stack is database/sql + SQLite, not Relica; examples/05 now demonstrates middleware.Timeout.

Verification: gofmt and go build ./... in examples/05-middleware; llms.txt numbers measured on go1.27.4 (coverage 94.0% core / 95.6% middleware, 501 tests, 22 benchmarks, 2 fuzz; 142 ns/op static and 213 ns/op parametric, 0 B/op); CI runs the full matrix.

@codecov

codecov Bot commented Nov 11, 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 15f63c2 into main Nov 11, 2026
17 checks passed
@kolkov
kolkov deleted the docs/llms-refresh branch November 11, 2026 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant