mirror of
https://github.com/lukaszraczylo/go-telegram.git
synced 2026-06-05 22:43:59 +00:00
lukaszraczylo
1088b7f4d7
- Add gomarkdoc-driven reference docs in docs/reference/, regenerated automatically by 'make regen' alongside the api/ codegen - New 'make docs' target installs gomarkdoc on first run; 'make docs-check' is a CI gate - Fold doc-clean assertion into existing codegen-clean job (single diff check covers spec + api + reference) - Rewrite README header: logo via <picture>, friendlier tagline, emoji-led 'Why you'll like it' bullets instead of Why-table - Drop duplicate echo snippet, soften 'Codegen pipeline' section into 'Keeping up with Telegram' - Link reference from README, Pages nav, and a new Markdown reference card on index.html (target = GitHub source view, renders .md natively)
API Reference
Auto-generated from Go source comments by gomarkdoc. Do not edit by hand — run make docs to regenerate.
Packages
| Package | Description |
|---|---|
api |
Telegram Bot API types and method wrappers — 176 methods, 301 types, fully generated |
client |
Bot client, codec, HTTP doer, retry middleware |
transport |
Long-poll and webhook transports |
dispatch |
Update router, filters, handler groups, named handlers |
dispatch/conversation |
Multi-step conversation state machines |
dispatch/filters/message |
Message filters — Command, Text, IsReply, etc. |
dispatch/filters/callback |
Callback query filters |
dispatch/filters/inline |
Inline query filters |
dispatch/filters/chatmember |
Chat member update filters |
dispatch/filters/chatjoinrequest |
Join request filters |
dispatch/filters/precheckoutquery |
Pre-checkout filters for payments |
Also see
- Project home — landing page with examples and overview
- GitHub repository
- pkg.go.dev — official Go package documentation