Skip to content

Commit 264ad76

Browse files
committed
docs: restructure guides index page with beginner path, topic sections, and quick reference navigation for both locales
Replace generic guides overview with structured learning path, add beginner series table (introduction/first-steps/TypeScript-keyboards), organize topic guides into Bot Setup & Deployment/Payments & Monetization/Filtering & Routing/AI & Tooling/Migration sections, add quick references section with links to cheat-sheet/bot-api/formatting/keyboards/triggers/hooks/files/plugins/testing,
1 parent b397213 commit 264ad76

File tree

2 files changed

+137
-26
lines changed

2 files changed

+137
-26
lines changed

docs/guides/index.md

Lines changed: 64 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,79 @@
11
---
2-
title: GramIO guides - Powerful framework for creating Telegram bots with TypeScript/JavaScript
3-
2+
title: GramIO Guides — Learning Path for Telegram Bot Development
43
head:
54
- - meta
65
- name: "description"
7-
content: "Comprehensive guides and tutorials for the GramIO framework - learn how to create feature-rich Telegram bots with TypeScript and JavaScript. From basic setup to advanced techniques."
8-
6+
content: "GramIO guides for every skill level — from your first bot to production-ready architecture. Beginner tutorials, topic deep-dives, and advanced patterns."
97
- - meta
108
- name: "keywords"
11-
content: "telegram bot, framework, how to create a bot, Telegram, Telegram Bot API, GramIO, TypeScript, JavaScript, Node.JS, Nodejs, Deno, Bun, bot development guides, tutorials, step-by-step instructions, API documentation, Telegram bot development, learning materials, practical examples, bot code examples"
9+
content: "GramIO guides, telegram bot tutorial, TypeScript bot guide, bot development learning path, beginner telegram bot, GramIO examples"
10+
---
11+
12+
# Guides
13+
14+
Practical guides for building Telegram bots with GramIO — from your first `/start` command to production-scale architecture.
15+
1216
---
1317

14-
# GramIO Guides
18+
## Beginner Path
19+
20+
New to GramIO or Telegram bots in general? Start here. This series walks you through building a real bot from scratch, explaining the concepts as you go.
21+
22+
| Step | What you'll learn |
23+
|------|-------------------|
24+
| [1. Introduction](/guides/for-beginners/1) | What GramIO is, how Telegram bots work, getting your bot token |
25+
| [2. First steps](/guides/for-beginners/2) | Setting up the project, handling your first command |
26+
| [3. TypeScript & keyboards](/guides/for-beginners/3) | Type safety in practice, inline and reply keyboards |
27+
28+
---
29+
30+
## Topic Guides
31+
32+
Focused deep-dives on specific features and integrations.
1533

16-
Welcome to the GramIO guides section. Here you'll find detailed information and tutorials to help you create amazing Telegram bots with the GramIO framework.
34+
### Bot Setup & Deployment
1735

18-
## Contents
36+
- [Get started](/get-started) — Scaffold, run, and understand the project structure
37+
- [Webhooks](/guides/webhook) — Run your bot on a web server instead of long polling
38+
- [Docker](/guides/docker) — Containerize your bot for easy deployment
1939

20-
- [Getting Started](/get-started) - Quick start guide for creating your first bot
21-
- [Bot API](/bot-api) - Learn about the Telegram Bot API specifics
22-
- [Bot Class](/bot-class) - Understanding the main Bot class and its features
23-
- [Plugins](/plugins/overview) - Extend your bot's functionality with plugins
24-
- [Hooks](/hooks/overview) - React to different events in your bot's lifecycle
25-
- [Formatting](/formatting/format) - Style your messages with formatting tools
26-
- [Keyboards](/keyboards/overview) - Add interactive buttons to your bot
40+
### Payments & Monetization
2741

28-
## Project Examples
42+
- [Telegram Stars](/guides/telegram-stars) — Accept payments with Telegram's native payment system
2943

30-
We'll be adding complete project examples soon to demonstrate how to build various types of bots with GramIO.
44+
### Filtering & Routing
45+
46+
- [Filters](/guides/filters) — Route updates to the right handler with composable filter functions
47+
48+
### AI & Tooling
49+
50+
- [AI Skills](/guides/ai-skills) — Give your AI assistant deep GramIO knowledge with installable skills
51+
52+
### Migrating from another framework
53+
54+
- [Migrate from grammY](/guides/migration-from-grammy) — Side-by-side code comparisons for grammY users
55+
- [Migrate from puregram](/guides/migration-from-puregram) — Side-by-side code comparisons for puregram users
56+
57+
---
58+
59+
## Quick references
60+
61+
Already know the basics? Jump straight to what you need:
62+
63+
- [Cheat Sheet](/cheat-sheet) — Most common patterns in one page
64+
- [Bot API](/bot-api) — How GramIO maps to the Telegram Bot API
65+
- [Formatting](/formatting) — Bold, italic, code, spoilers without `parse_mode`
66+
- [Keyboards](/keyboards/overview) — Inline, reply, remove, force-reply keyboards
67+
- [Triggers](/triggers/hears) — Commands, hears, callback queries, inline queries
68+
- [Hooks](/hooks/overview) — onStart, onStop, onError, preRequest, onResponse
69+
- [Files](/files/overview) — Upload, download, reuse media
70+
- [Plugins](/plugins/overview) — Sessions, scenes, i18n, and more
71+
- [Testing](/testing) — Test your bot with `@gramio/test`
72+
73+
---
3174

32-
## Feedback
75+
## Need help?
3376

34-
Have suggestions for new guides or found an issue? Feel free to create an issue in our [GitHub repository](https://github.com/gramiojs/docs/issues).
77+
- Browse the [Telegram API Reference](/telegram/) — every method with GramIO examples
78+
- Open an issue on [GitHub](https://github.com/gramiojs/gramio/issues)
79+
- Chat in the [GramIO Telegram community](https://t.me/gramio_forum)

docs/ru/guides/index.md

Lines changed: 73 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,79 @@
1-
<!-- ---
2-
title: Руководства по GramIO - Мощный фреймворк для создания ботов Telegram на TypeScript/JavaScript
3-
1+
---
2+
title: Гайды GramIO — Путь обучения разработке Telegram-ботов
43
head:
54
- - meta
65
- name: "description"
7-
content: Руководства по разработке Telegram ботов с использованием фреймворка GramIO. Узнайте, как создавать мощные и расширяемые боты.
8-
6+
content: "Гайды GramIO для любого уровня — от первого бота до продакшен-архитектуры. Туториалы для начинающих, тематические deep-dive'ы и продвинутые паттерны."
97
- - meta
108
- name: "keywords"
11-
content: телеграм бот, фреймворк, как создать бота, Telegram, Telegram Bot API, GramIO, TypeScript, JavaScript, Node.JS, Nodejs, Deno, Bun, руководства по созданию ботов, гайды, пошаговые инструкции, документация API, разработка Telegram ботов, обучающие материалы, туториалы, практические примеры, примеры кода для ботов
9+
content: "гайды GramIO, туториал telegram бот, гайд TypeScript бот, путь обучения разработке ботов, telegram бот для начинающих, примеры GramIO"
1210
---
13-
-->
11+
12+
# Гайды
13+
14+
Практические гайды по созданию Telegram-ботов с GramIO — от первой команды `/start` до масштабируемой продакшен-архитектуры.
15+
16+
---
17+
18+
## Путь для начинающих
19+
20+
Новичок в GramIO или Telegram-ботах вообще? Начните здесь. Эта серия проведёт вас через создание настоящего бота с нуля, объясняя концепции по ходу.
21+
22+
| Шаг | Что вы узнаете |
23+
|-----|----------------|
24+
| [1. Введение](/ru/guides/for-beginners/1) | Что такое GramIO, как работают Telegram-боты, получение токена |
25+
| [2. Первые шаги](/ru/guides/for-beginners/2) | Настройка проекта, обработка первой команды |
26+
| [3. TypeScript и клавиатуры](/ru/guides/for-beginners/3) | Типобезопасность на практике, инлайн и обычные клавиатуры |
27+
28+
---
29+
30+
## Тематические гайды
31+
32+
Сфокусированные deep-dive'ы по конкретным функциям и интеграциям.
33+
34+
### Настройка и деплой бота
35+
36+
- [Начало работы](/ru/get-started) — Скаффолдинг, запуск и понимание структуры проекта
37+
- [Webhook](/ru/updates/webhook) — Запуск бота на веб-сервере вместо long polling
38+
- [Docker](/ru/guides/docker) — Контейнеризация бота для удобного деплоя
39+
40+
### Платежи и монетизация
41+
42+
- [Telegram Stars](/ru/guides/telegram-stars) — Приём платежей с помощью нативной платёжной системы Telegram
43+
44+
### Фильтрация и маршрутизация
45+
46+
- [Фильтры](/ru/guides/filters) — Маршрутизация обновлений в нужный обработчик с помощью компонуемых функций фильтрации
47+
48+
### AI и инструменты
49+
50+
- [AI Skills](/ru/guides/ai-skills) — Дайте вашему AI-ассистенту глубокие знания о GramIO с помощью устанавливаемых скиллов
51+
52+
### Миграция с другого фреймворка
53+
54+
- [Миграция с grammY](/ru/guides/migration-from-grammy) — Сравнение кода для пользователей grammY
55+
- [Миграция с puregram](/ru/guides/migration-from-puregram) — Сравнение кода для пользователей puregram
56+
57+
---
58+
59+
## Быстрый доступ
60+
61+
Уже знаете основы? Переходите прямо к нужному:
62+
63+
- [Шпаргалка](/ru/cheat-sheet) — Самые частые паттерны на одной странице
64+
- [Bot API](/ru/bot-api) — Как GramIO работает с Telegram Bot API
65+
- [Форматирование](/ru/formatting) — Bold, italic, code, spoiler без `parse_mode`
66+
- [Клавиатуры](/ru/keyboards/overview) — Инлайн, обычные, удаление, force-reply клавиатуры
67+
- [Триггеры](/ru/triggers/hears) — Команды, hears, callback query, inline query
68+
- [Хуки](/ru/hooks/overview) — onStart, onStop, onError, preRequest, onResponse
69+
- [Файлы](/ru/files/overview) — Загрузка, скачивание, переиспользование медиа
70+
- [Плагины](/ru/plugins/overview) — Сессии, сцены, i18n и многое другое
71+
- [Тестирование](/ru/testing) — Тестирование бота с `@gramio/test`
72+
73+
---
74+
75+
## Нужна помощь?
76+
77+
- Изучите [Telegram API Reference](/telegram/) — каждый метод с примерами GramIO
78+
- Создайте issue на [GitHub](https://github.com/gramiojs/gramio/issues)
79+
- Пообщайтесь в [сообществе GramIO в Telegram](https://t.me/gramio_forum)

0 commit comments

Comments
 (0)