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.

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
6 changes: 4 additions & 2 deletions site/docs/guide/README.md
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
6 changes: 4 additions & 2 deletions site/docs/id/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,15 @@ Dokumentasi bot grammY dibagi menjadi tiga area:

**Area pertama**---yang sedang kamu baca saat ini---berisi tutorial penggunaan grammY dan penjelasan mengenai cara kerja dari suatu bot.
Dokumen ini yang akan paling sering kamu gunakan.
Kamu bisa memulai dari bab _Belajar_ di tab navigasi yang ada di bagian atas halaman ini.
Untuk memahami konsep dasar secara keseluruhan, kamu bisa memulai dari bab _Belajar_ yang berada di tab navigasi bagian atas halaman ini.
Jangan lupa untuk melihat koleksi _Plugin_ kami yang menakjubkan serta berbagai _Contoh_ yang sudah disediakan.

**Area kedua** adalah [referensi API grammY](/ref/core/), yang juga bisa diakses melalui tab navigasi di bagian atas halaman.
**Area kedua** adalah [referensi API grammY](/ref/), yang juga bisa diakses melalui tab navigasi di bagian atas halaman.
Referensi ini berisi gambaran terperinci dari setiap bit kode yang disediakan grammY.
Ia juga menghasilkan penjelasan-penjelasan bermanfaat dalam bentuk tooltip yang dibuat secara otomatis dari kode program grammY.
Tooltip tersebut dapat ditemukan dengan mengarahkan kursor ke berbagai elemen grammY di kode editor.
Hal yang sama juga berlaku untuk setiap plugin di ekosistem grammY.
Selain tercantum di [referensi utama API](/ref/), setiap plugin juga mencantumkan referensi API-nya masing-masing di ringkasan plugin pada bagian bawah halaman.

**Area ketiga** berisi daftar _raw definition_ dari [API HTTP](https://core.telegram.org/bots/api) yang disediakan oleh Telegram.
API ini akan digunakan oleh grammY untuk memberi perintah ke bot kamu.
Expand Down
6 changes: 4 additions & 2 deletions site/docs/uk/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@ grammY --- це фреймворк для створення ботів Telegram
**Перша частина** (ви дивитеся її!) пояснює, як працюють боти та як використовувати grammY.
Це те, чим ви будете користуватися найчастіше.

Розділ _Вивчення_ завжди є хорошим початком.
Розділ _Вивчення_ завжди є хорошим початком, оскільки в ньому пояснюються всі основні концепції.
Також перегляньте нашу чудову колекцію _Плагінів_ і подивіться на _Приклади_.

**Друга частина** --- це [довідка API grammY](/ref/core/), посилання на яке знаходиться у верхній частині сторінки.
**Друга частина** --- це [довідка API grammY](/ref/), посилання на яку знаходиться у верхній частині сторінки.
Це детальний огляд кожного окремого біта коду, який надає grammY.
Він автоматично генерується з коду grammY і містить усі корисні пояснення, які зазвичай можна знайти, навівши курсор на будь-який елемент grammY у редакторі коду.
Те саме стосується кожного плагіна в екосистемі grammY.
Окрім того, що плагіни зʼявляються в [огляді довідки API](/ref/), посилання на довідку містяться в короткому описі внизу сторінки кожного плагіна.

**Третя частина** надається Telegram і містить перелік необроблених визначень [HTTP API](https://core.telegram.org/bots/api), до якого grammY підключатиметься під капотом.
Посилання на API grammY є скрізь, де це має сенс.
Expand Down
6 changes: 4 additions & 2 deletions site/docs/zh/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,14 @@ grammY 是一个用于创建 Telegram Bot 的框架。它可以从 TypeScript

**第一部分**(你正在看它!)解释了 Bot 是如何工作的以及如何使用 grammY。
这是你最常用的部分。
你可以从 _了解_ 部分开始。
你可以从 _学习_ 部分开始,因为它解释了所有的核心概念
同时,请看一下我们的精彩的 _插件_ 集合,和 _示例_。

**第二部分**是 [grammY API 参考](/ref/core/),你也可以在页面顶部链接找到它。
**第二部分**是 [grammY API 参考](/ref/),你也可以在页面顶部链接找到它。
这是一份关于 grammY 所提供的所有代码的详细概述。
它是由 grammY 的代码自动生成的,并且包含所有有用的提示,通常通过悬停你的鼠标在 grammY 中的任何代码编辑器中找到。
grammY 生态系统中的每个插件也是如此。
除了出现在 [API 参考概述](/ref/) 中之外,插件还在每个插件页面底部的插件摘要中提供了其 API 参考的链接。

**第三部分**是 Telegram 提供的,并且列出了 grammY 在内部连接的原始 [HTTP API](https://core.telegram.org/bots/api)。
grammY API 参考会在任何有意义的地方提供一个访问它的链接。
Expand Down
Loading