docs: bring the documentation up to date for 1.0 - #40
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR #39 fixed the renames. This covers what was still stale or missing after that.
Landing page
docs/README.mdwas the most out of date page in the whole site — and it is the first one anyone opens.TelegramBot v22.9.0→v22.10.2.1, plus the supported Bot API 10.2 and the target frameworkMessageBuilder, 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.Point fixes
api/klassy/optionmessage.mdInputFile? thumbnailInputFile? Thumbnail— renamed in 1.0api/metody-rasshireniya/pageextension.mdasync Task<PagedResult<T>>Task<PagedResult<T>>— no longer declaredasyncpostranichnyi-vyvod-informacii-v-soobshenie.mdasync, andthis IList<T>Task, andthis IEnumerable<T>— that overload never existedNew 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.Helpers.Messagefacade, the four unified namespaces, the two renamed attributes, the fixed typos, what was removed because it never worked, what becameinternal, and the four behaviour changes that compile fine but act differently.All three are wired into
SUMMARY.md.Verification
AddRequestManagedBot,ShowCaptionAboveMedia,RequireChatTypeAttribute,RequireMessageTypeAttribute,ChatTypes,MessageTypes,AutoEditMessageCycle, and the four new namespaces all exist;Helpers/Message.csandWorkflow/are confirmed gone.SUMMARY.mdresolve to files that exist.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