Skip to content

docs: bring the documentation up to date for 1.0 - #40

Merged
prethink merged 1 commit into
masterfrom
docs/update-for-1.0
Aug 23, 2026
Merged

prethink merged 1 commit into
masterfrom
docs/update-for-1.0

Conversation

@prethink

Copy link
Copy Markdown
Owner

PR #39 fixed the renames. This covers what was still stale or missing after that.

Landing page

docs/README.md was the most out of date page in the whole site — and it is the first one anyone opens.

  • "Документация актуальна для версии 0.9.7" → 1.0.0
  • TelegramBot v22.9.0 → v22.10.2.1, plus the supported Bot API 10.2 and the target framework
  • The feature list was still the pre-0.9 flat one. It was missing keyboard builders, MessageBuilder, inline confirmations, inline converters and serializers, media helpers, CurrentScope, hosted service, group utilities, logging and the slash-command argument separator. Replaced with the grouped list from the repository README, so the two now say the same thing.
  • Added a pointer to the migration page for anyone arriving from 0.9.x.

Point fixes

Page Was Now
api/klassy/optionmessage.md InputFile? thumbnail InputFile? Thumbnail — renamed in 1.0
api/metody-rasshireniya/pageextension.md async Task<PagedResult<T>> Task<PagedResult<T>> — no longer declared async
postranichnyi-vyvod-informacii-v-soobshenie.md async, and this IList<T> Task, and this IEnumerable<T> — that overload never existed

New pages

Three features had zero coverage anywhere in the docs:

  • MessageBuilder — the feature list advertises it and nothing described it. Documents positional arguments, named tokens, lazy resolvers, and the deliberate behaviour of leaving an unresolved token in place.
  • InlineCopyText — added in 1.0. Notes that no handler is needed, since the copy happens client-side.
  • Переход на 1.0 — every breaking change that requires a code change, with before/after tables: the deleted Helpers.Message facade, the four unified namespaces, the two renamed attributes, the fixed typos, what was removed because it never worked, what became internal, and the four behaviour changes that compile fine but act differently.

All three are wired into SUMMARY.md.

Verification

  • Both new code samples were compiled against the library before being written down.
  • Every identifier named on the migration page was checked against the source — AddRequestManagedBot, ShowCaptionAboveMedia, RequireChatTypeAttribute, RequireMessageTypeAttribute, ChatTypes, MessageTypes, AutoEditMessageCycle, and the four new namespaces all exist; Helpers/Message.cs and Workflow/ are confirmed gone.
  • All 143 links in SUMMARY.md resolve to files that exist.
  • CRLF and the absence of a BOM are preserved across all 144 files, matching the GitBook export.

Note on GitBook

docs/ is synced with GitBook. While this PR is open, avoid editing these pages in the web editor to prevent a conflict.

🤖 Generated with Claude Code

The mechanical renames were fixed earlier; this covers what was still
stale or missing.

Landing page:
- "Documentation is current for 0.9.7" -> 1.0.0
- Telegram.Bot v22.9.0 -> v22.10.2.1, plus the supported Bot API version
  and the target framework
- the feature list was the pre-0.9 flat one and had fallen behind by a
  dozen features; replaced with the grouped list from the repository README

Point fixes:
- OptionMessage.thumbnail -> Thumbnail (renamed in 1.0)
- GetPaged is no longer declared async, and takes IEnumerable<T>, not
  IList<T>; both listings showed the old shape

New pages, for 1.0 features that had no coverage at all:
- MessageBuilder, which the feature list advertises but nothing described
- InlineCopyText, added in 1.0
- "Migration to 1.0", covering every breaking change that needs a code
  change, with before/after tables

Both new samples were compiled against the library before being written
down. Every identifier named on the migration page was checked against
the source.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@prethink
prethink merged commit eccbe67 into master Aug 23, 2026
2 checks passed
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