Add source-linked API reference#2
Open
mossony wants to merge 1 commit into
Open
Conversation
mossony
marked this pull request as ready for review
July 19, 2026 02:28
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.
Summary
Why
The README gives concise usage examples, but the package does not currently have a browsable API reference. This keeps the README focused while making validation, signing, data-model, exception, and optional FastAPI APIs searchable and source-linked.
Impact
This is documentation-only and does not change the Python package or runtime behavior. The reference is regenerated from the source before every build. After merge, a maintainer needs to select GitHub Actions as the Pages source once; subsequent pushes to
maindeploy automatically.Validation
npm run check --prefix docspython3 -m pytest -q— 38 passed/telegram-init-data/base path on desktop and a 390×844 viewportPrepared with OpenAI Codex; I reviewed the generated reference and ran the checks above.