Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain plugin refs in overview #1017

Merged
merged 13 commits into from
Apr 6, 2024
Merged

Explain plugin refs in overview #1017

Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
fbc4927
Explain plugin refs in overview
KnorpelSenf Mar 20, 2024
36f8c4f
Merge branch 'main' into plugin-refs-explained
LWJerri Mar 22, 2024
6d90868
sync to Ukrainian
niusia-ua Mar 23, 2024
15c6fbe
Sync Translation to Indonesian
Mar 24, 2024
c5a52d2
docs (id) : Rephrase
Mar 26, 2024
5e973c6
docs (id) : Rephrase #2
Mar 26, 2024
980537c
docs (id) : Re-phrase
Mar 26, 2024
bc4a90c
Merge branch 'main' into plugin-refs-explained
rojvv Mar 27, 2024
5b40255
sync zh #1017
Mar 27, 2024
cf3a90c
Update site/docs/uk/guide/README.md
LWJerri Apr 4, 2024
fa04d6e
Update site/docs/uk/guide/README.md
LWJerri Apr 4, 2024
1088165
Merge branch 'main' into plugin-refs-explained
LWJerri Apr 4, 2024
78f7c42
Add Spanish
habemuscode Apr 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions site/docs/guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ The documentation for grammY bots is divided into three layers.

**The first part** (you're looking at it!) explains how bots work and how to use grammY.
This is what you will use most often.
The _Learn_ section is always a good start.
The _Learn_ section is always a good start, as it explains all core concepts.
Also check out our great collection of _Plugins_, and have a look at the _Examples_.

**The second part** is the [grammY API reference](/ref/core/), linked at the top of the page.
**The second part** is the [grammY API reference](/ref/), linked at the top of the page.
This is a detailed overview of every single bit of code that grammY provides.
It is automatically generated from grammY's code and contains all of the useful tooltip explanations, normally found by hovering your cursor over any element of grammY in a code editor.
The same is true for every plugin in the grammY ecosystem.
In addition to appearing in the [overview of API references](/ref/), plugins have their API reference linked in the plugin summary at the bottom of each plugin page.

**The third part** is provided by Telegram and lists the raw definitions of the [HTTP API](https://core.telegram.org/bots/api) that grammY will connect to under the hood.
The grammY API reference links to it wherever that makes sense.
Expand Down
Loading